File: HACKING

package info (click to toggle)
kdelibs 4:3.5.5a.dfsg.1-8
  • links: PTS
  • area: main
  • in suites: etch-m68k
  • size: 86,260 kB
  • ctags: 72,369
  • sloc: cpp: 575,111; xml: 116,385; ansic: 27,951; sh: 10,565; perl: 6,241; java: 4,066; makefile: 3,775; yacc: 2,432; lex: 643; ruby: 329; asm: 166; jsp: 128; haskell: 116; f90: 99; ml: 75; awk: 71; tcl: 29; lisp: 24; php: 9
file content (100 lines) | stat: -rw-r--r-- 2,312 bytes parent folder | download | duplicates (13)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Coding Style
============

See http://korganizer.kde.org/hacking.html for an HTML version.

Formatting
----------

- No Tabs.
- Indent with 2 spaces.
- A line must not have more than 80 chars.
- Put Spaces between brackets and arguments of functions.
- For if, else, while and similar statements put the brackets on the same line
  as the statement.
- Function and class definitions have their brackets on separate lines.

Example:

void MyClass::myFunction()
{
  if ( blah == fasel ) {
    blubbVariable = arglValue;
  } else {
    blubbVariable = oerxValue;
  }
}


Header Formatting
-----------------

- General formatting rules apply.
- Access modifiers are indented.
- Put curly brackets of class definition on its own line.
- Double inclusion protection defines are all upper case letters and are
  composed of the namespace (if available), the classname and a H suffix
  separated by underscores.
- Inside a namespace there is no indentation.

Example:

#ifndef XKJ_MYCLASS_H
#define XKJ_MYCLASS_H

namespace XKJ {

class MyClass
{
  public:
    MyClass();
    
  private:
    int mMyInt;
};

}

#endif


API docs
--------

- Each public function must have a Doxygen compatible comment in the header
- Use C-style comments without additional asterisks
- Indent correctly.
- Comments should be grammatically correct, e.g. sentences start with uppercase
  letters and end with a full stop.
- Be concise.

Example:

  /**
    This function makes tea.
    
    @param cups number of cups.
    @result tea
  */
  Tea makeTea( int cups );


Class and File Names
--------------------

- Put classes in files, which have the same name as the class, but only
  lower-case letters.
- Designer-generated files should have a name classname_base.ui and shoul
  contain a class called ClassnameBase.
- Classes inheriting from designer-generated classes have the same name as the
  generated class, but without the Base suffix.

Class and Variable Names
------------------------

- For class, variable, function names seperate multiple words by upper-casing
  the words precedeed by other words.
- Class names start with an upper-case letter.
- Function names start with a lower-case letter.
- Variable names start with a lower-case letter.
- Member variables of a class start with "m" followed by an upper-case letter.