3 \page coding_style Hugo Coding Style
5 \section Naming Conventions
7 In 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.
9 \subsection cs-class Classes and other types
11 The name of a class or any type should look like the following:
14 AllWordsCapitalizedWithoutUnderscores
17 \subsection cs-func Methods and other functions
19 The name of a function should look like the following:
22 firstWordLowerCaseRestCapitalizedWithoutUnderscores
25 \subsection cs-funcs Constants, Macros
27 The names of constants and macros should look like the following:
30 ALL_UPPER_CASE_WITH_UNDERSCORES
33 \subsection cs-loc-var Class and instance member variables, auto variables
35 The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following:
38 all_lower_case_with_underscores
41 \subsection cs-excep Exceptions
43 When writing exceptions please comply the following naming conventions:
46 ClassNameEndsWithException