doc/coding_style.dox
author athos
Mon, 03 May 2004 14:42:40 +0000
changeset 513 60afd11e6cb3
parent 507 dcfb68446843
child 603 86458ad390a7
permissions -rw-r--r--
xy_test added: it was not entirely useless, I found a mistake in xy.h
alpar@507
     1
/*!
alpar@507
     2
alpar@509
     3
\page coding_style Hugo Coding Style 
alpar@507
     4
alpar@507
     5
\todo More detailed description, an introductory paragraph, etc.
alpar@507
     6
 
alpar@507
     7
\section Naming Convenions
alpar@507
     8
alpar@507
     9
\subsection Classes
alpar@507
    10
alpar@507
    11
\code
alpar@507
    12
AllWordsCapitalizedWithoutUnderscores 
alpar@507
    13
\endcode
alpar@507
    14
alpar@507
    15
\subsection Methods
alpar@507
    16
alpar@507
    17
\code
alpar@507
    18
firstWordLowerCaseRestCapitalizedWithoutUnderscores 
alpar@507
    19
\endcode
alpar@507
    20
alpar@507
    21
\subsection Constants
alpar@507
    22
alpar@507
    23
\code
alpar@507
    24
ALL_UPPER_CASE_WITH_UNDERSCORES 
alpar@507
    25
\endcode
alpar@507
    26
alpar@507
    27
\subsection %Class and instance member variables
alpar@507
    28
alpar@507
    29
\code
alpar@507
    30
all_lower_case_with_underscores 
alpar@507
    31
\endcode
alpar@507
    32
alpar@507
    33
\subsection Auto variables (=variables used locally in methods)
alpar@507
    34
alpar@507
    35
\code
alpar@507
    36
all_lower_case_with_underscores 
alpar@507
    37
\endcode
alpar@507
    38
alpar@507
    39
\subsection Exceptions
alpar@507
    40
alpar@507
    41
\code
alpar@507
    42
ClassNameEndsWithException
alpar@507
    43
\endcode
alpar@507
    44
alpar@507
    45
alpar@507
    46
*/