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