Project

General

Profile

CodeStyle » History » Version 19

Alex Afanasyev, 03/29/2014 11:38 AM

1 1 Junxiao Shi
# NFD code style guidelines
2
3
NFD adopts [NDN Platform C++, C, C#, Java and JavaScript Code Guidelines](http://named-data.net/codebase/platform/documentation/ndn-platform-development-guidelines/cpp-code-guidelines/), with the following exceptions:
4
5 10 Alex Afanasyev
*   (amended 8) Names representing generic template types should be a single uppercase letter
6
7
        template<class T> ...
8
        template<class C, class D> ...
9
10
    However, when template parameter represents a certain concept and expected to have a certain interface, the name should be explicitly spelled out:
11
12
        template<class FaceBase> ...
13
        template<class Packet> ...
14
15 8 Junxiao Shi
*   (amended 10)
16
    Global variables should have `g_` prefix
17 1 Junxiao Shi
18 8 Junxiao Shi
*   (amended 11)
19 15 Alex Afanasyev
    **Private** class variables should have `m_` prefix.
20
    **Static** class variables should have `s_` prefix.
21 8 Junxiao Shi
22 11 Alex Afanasyev
*   (amended 26)
23
    Allow commonly used abbreviated **next/prev** pair in addition to **next/previous**
24
25 12 Alex Afanasyev
    Pair **insert/erase** should be used for any new code, already implemented code can keep **insert/delete** if it does not conflict with C++ delete keyword.
26
27 13 Alex Afanasyev
*   (amended 27)
28 14 Alex Afanasyev
    In cases when full word is too long, a commonly accepted abbreviation can be used.  For example, **dest** instead of **destination**.
29 13 Alex Afanasyev
30 8 Junxiao Shi
*   (amended 31)
31
    Exceptions can be used in the code, but should be used only in **exceptional** cases and not in the primary processing path.
32
33
    Exceptions can be suffixed with either `Exception` (eg. SecurityException) or `Error` (eg. SecurityError).  Alternatively (and it is a recommended method), one should declare exception class `Exception` or `Error` as an inner class, from which the exception is thrown. For example, when declaring class Foo that can throw errors, one can write the following:
34
35 5 Alex Afanasyev
        #include <stdexcept>
36 1 Junxiao Shi
        
37
        class Foo
38 5 Alex Afanasyev
        {
39 1 Junxiao Shi
            struct Error : std::runtime_exception
40
            {
41
                Error(const std::string& what) : std::runtime_error(what) {}
42
            };
43
        };
44
45 8 Junxiao Shi
    In addition to that, if class Foo is a base class or interface for some class hierarchy, then child classes should should define their own `Error` or `Exception` classes that are inherited from the parent's Error class.
46 1 Junxiao Shi
47 8 Junxiao Shi
*   (amended 33)
48
    We will use only `.cpp` and `.hpp` extensions
49 1 Junxiao Shi
50 8 Junxiao Shi
*   (removed 35)
51 17 Davide Pesavento
    Lines should be within a reasonable range. Lines longer than 100 columns should generally be avoided.
52 8 Junxiao Shi
53 18 Alex Afanasyev
*   (updated 37)
54
    Exceptions:
55
56
    * The following is the standard practice with ``operator<<``:
57
58
            std::cout << "Something here "
59
                      << "Something there" << std::endl;
60
61 8 Junxiao Shi
*   (removed 44)
62
    Implicit conversion is generally allowed.
63
64
    Implicit conversion between integer and floating point numbers can cause problems and should be avoided.
65
66
    Implicit conversion in single-argument constructor is usually undesirable. Therefore, all single-argument constructors should be marked 'explicit', unless implicit conversion is desirable. In that case, a comment should document the reason.
67
68
    Avoid C-style casts.  Use `static_cast`, `dynamic_cast`, `reinterpret_cast`, `const_cast` instead where appropriate.
69
70 16 Alex Afanasyev
*   (replaced 48)
71 17 Davide Pesavento
    In most cases, class instance variables should never be declared public.
72 16 Alex Afanasyev
    
73 17 Davide Pesavento
    The concepts of information hiding and encapsulation are violated by public variables. Use private variables and access methods instead. One exception to this rule is when the class is essentially a dumb data structure with no behavior (equivalent to a C struct, also known as PODS).  In this case it is appropriate to make the instance variables public by using ``struct``.
74 16 Alex Afanasyev
75 8 Junxiao Shi
*   (amended 68)
76
    All three presented styles ARE acceptable.  First and third ARE recommended (these are actually GNU styles).
77
78
*   (amended 69)
79
    The class declarations should have the following form:
80
81 3 Alex Afanasyev
        class SomeClass : public BaseClass 
82 4 Junxiao Shi
        { 
83 3 Alex Afanasyev
        public: 
84 4 Junxiao Shi
          ... <public methods> ...
85 3 Alex Afanasyev
        protected: 
86
          ... <protected methods> ...
87
        private: 
88 1 Junxiao Shi
          ... <private methods> ...
89
        
90
        public: 
91
          ... <public data> ...
92 3 Alex Afanasyev
        protected: 
93
          ... <protected data> ...
94
        private: 
95
          ... <private data> ...
96
        };
97
98
    ``public``, ``protected``, ``private`` may be repeated several times without interleaving (e.g. public, public, public, private, private) if this allows better readability of the code.
99
100 8 Junxiao Shi
*   (amended 70)
101
    When declaring/defining function/method, the return type should be put on a separate line before function/method name.
102
103
    Method and function definitions should have the following form:
104 3 Alex Afanasyev
105
        void
106
        someMethod() 
107
        { 
108
          ... 
109 1 Junxiao Shi
        }
110 9 Alex Afanasyev
111
*   (amended 76) No space requirement before : in switch statements
112
113
        switch (condition) { 
114
          case ABC:
115
            statements; 
116
            // Fallthrough 
117
        
118
          case DEF: 
119
            statements; 
120
            break;
121
        
122
          case XYZ: 
123
            statements; 
124
            break; 
125
        
126
          default: 
127
            statements; 
128
            break;
129
        }    
130 19 Alex Afanasyev
131
## Python addition
132
133
Most of the provisions in the above style guidance apply to Python as well.  For python-specific elements, [PEP 8](http://legacy.python.org/dev/peps/pep-0008/) can be used as a reference coding style.  
134
135
The following is few rules directly adopted from [PEP 8](http://legacy.python.org/dev/peps/pep-0008/):
136
137
* **P1**  Always surround these binary operators with a single space on either side: assignment (=), augmented assignment (+=, -= etc.), comparisons (==, <, >, !=, <>, <=, >=, in, not in, is, is not), Booleans (and, or, not).
138
139
        def complex(real, imag=0.0):
140
            value = 1.1
141
            return magic(r=real + value, i=imag)
142
143
* **P2** Don't use spaces around the = sign when used to indicate a keyword argument or a default parameter value.
144
145
        def complex(real, imag=0.0):
146
            return magic(r=real, i=imag)