Naming conventions

Top  Previous 

 

In the help and in the examples some name conventions are used almost generally. They shall simplify reading the scripts. The use of such conventions in your source text also can be of a great use if you want to work on it with the TextTransformer later once. However, the use of the conventions is completely up to you. The use of the TextTransformer depends on it in no way.

 

Exception: the function table wizard doesn't work correctly with function tables, if the name doesn't begin with "m_ft".

 

An abbreviated type name is put in front of variables.

 

type

identifier

example

 

 

 

bool

b

bVar

char

c

cVar

int

i

iVar

unsigned int

ui

uiVar

double

d

dVar

str

s

sVar

node

n

nLeaf

vector

v

vParams

map

m

mReplace

cursor

cr

cr1

function table

ft

ftPrint

 

 

m_ is put in front of the names of class variables.

 

Example:   m_sColor        a class variable of the type str

 

 

x is put in front of the names of parameter variables.

 

Example:   xsColor        a parameter of the type str

 

 

 

 



This page belongs to the TextTransformer Documentation

Home  Content  German