Tornado

Tornado 2.0
User’s Guide
■
Comments on global variables appear on the same line as the variable
declaration, using the semicolon (;) character:
set day night ;# This is a global variable
B.3.6 Naming Conventions
The following conventions define the standards for naming modules, routines and
variables. The purpose of these conventions is uniformity and readability of code.
■
■
■
■
When creating names, remember that code is written once but read many
times. Make names meaningful and readable. Avoid obscure abbreviations.
Names of routines and variables are composed of upper- and lowercase
characters and no underbars. Capitalize each “word” except the first:
aVariableName
Every module has a short prefix (two to five characters). The prefix is attached
to the module name and to all externally available procedures and variables.
(Names that are not available externally need not follow this convention.)
fooLib.tcl
fooObjFind
fooCount
Names of procedures follow the module-noun-verb rule. Start the procedure
name with the module prefix, followed by the noun or object that the
procedure manipulates. Conclude the name with the verb or action that the
procedure performs:
fooObjFind
sysNvRamGet
taskInfoGet
module name
procedure name
variable name
foo - object - find
system - non volatile RAM - get
task - info - get
B.3.7 Tcl Style
The following conventions define additional standards of programming style:
■
■
■
Comments: Insufficiently commented code is unacceptable.
Procedure Length: Procedures should have a reasonably small number of
lines, less than 50 if possible.
Case Statement: Do not use the case keyword. Use switch instead.
334