debian/midori
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Elaborate declarations, comments and curly brackets in HACKING file

Browse source
This commit is contained in:
Christian Dywan 2010-01-29 23:21:36 +01:00
parent 753af1c32e
commit 1b70dc9520
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
HACKING
View file

@ -5,13 +5,21 @@ This file is licensed under the terms of the expat license, see the file EXPAT.
Indentation is 4 spaces, no tabs, preferrably at 80 to 120 columns per line to Indentation is 4 spaces, no tabs, preferrably at 80 to 120 columns per line to
avoid automated line-breaks. Trailing whitespace is not desirable. avoid automated line-breaks. Trailing whitespace is not desirable.
Declarations go to the beginning of a block, not inline. Variables of one plain
type may be grouped in one declaration, pointer types may not be grouped. The
asterisk goes next to the type.
Comments explain functionality, they should not state facts. The appropriate
style is always C style /* */, not C++ style.
Variable and function names should be animal, animal_shelter or animalsc in Variable and function names should be animal, animal_shelter or animalsc in
case it would otherwise be very long. Loop counters may be single letters. case it would otherwise be very long. Loop counters may be single letters.
Type names should be Animal, AnimalShelter or AnimalSC. Type names should be Animal, AnimalShelter or AnimalSC.
There is a space between functions or keywords and round brackets, and curly There is a space between functions or keywords and round brackets, and curly
brackets always go on separate lines, at the indentation level of the brackets always go on separate lines, at the indentation level of the
function, conditional or loop expression. function, conditional or loop expression. Curly brackets are left out for single
statement conditionals and loops unless they notably help readability.
The type of a function goes on a separate line before the function. The type of a function goes on a separate line before the function.
Preprocessor instructions are indented with the code they relate to. Preprocessor instructions are indented with the code they relate to.