COIN-OR::LEMON - Graph Library

Changeset 603:86458ad390a7 in lemon-0.x for doc/coding_style.dox


Ignore:
Timestamp:
05/11/04 11:30:06 (15 years ago)
Author:
athos
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@784
Message:

I completed the description of the coding style.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/coding_style.dox

    r509 r603  
    33\page coding_style Hugo Coding Style
    44
    5 \todo More detailed description, an introductory paragraph, etc.
    6  
    7 \section Naming Convenions
     5\section Naming Conventions
    86
    9 \subsection Classes
     7In order to make development easier we have made some conventions according to coding style. These include names of types, classes, functions, variables, constants and exceptions. If these conventions are met in one's code then it is easier to read and maintain it. Please comply with these conventions if you want to contribute developing Hugo library.
     8
     9\subsection Classes and other types
     10
     11The name of a class or any type should look like the following:
    1012
    1113\code
     
    1315\endcode
    1416
    15 \subsection Methods
     17\subsection Methods and other functions
     18
     19The name of a function should look like the following:
    1620
    1721\code
     
    1923\endcode
    2024
    21 \subsection Constants
     25\subsection Constants, Macros
     26
     27The names of constants and macros should look like the following:
    2228
    2329\code
     
    2531\endcode
    2632
    27 \subsection %Class and instance member variables
     33\subsection Class and instance member variables, auto variables
    2834
    29 \code
    30 all_lower_case_with_underscores
    31 \endcode
    32 
    33 \subsection Auto variables (=variables used locally in methods)
     35The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following:
    3436
    3537\code
     
    3941\subsection Exceptions
    4042
     43When writing exceptions please comply the following naming conventions:
     44
    4145\code
    4246ClassNameEndsWithException
Note: See TracChangeset for help on using the changeset viewer.