File: CodingConventions.txt

package info (click to toggle)
fwbuilder 1.0.0-2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 4,508 kB
  • ctags: 2,655
  • sloc: cpp: 15,549; sh: 7,494; ansic: 3,538; xml: 3,418; makefile: 906; perl: 397
file content (48 lines) | stat: -rw-r--r-- 1,093 bytes parent folder | download
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
# $Id: CodingConventions.txt,v 1.1 2001/08/04 17:38:58 lord Exp $

Title: Firewall Builder Project Coding Conventions
Author: Vadim Zaliva <lord@crocodile.org>

C++ code
--------

Class names: Starting from upper case, capitalising each subsequent word, without
underscores. 
Example: OptionsDialog

Constants: All caps, words separated by underscores.
Example: DEFAULT_TIMEOUT

Methods: Statring from lower case, capitalising each subsequent word, without
underscores. 
Example: startOperation();

Variables: all lower case, words separated by underscores.
Example: current_length;

First file included into every source file should be "config.h".

File Extentions:
----------------

Plain text: .txt
html: .html
C++ code: .cc
C++ header: .hh

File Names
------------

One source + one header file per class recommended.

C++ source and header file names must match class name with
appropriate extention added.

Example: Firewall.hh, Firewall.cc

If file contains several classes of related functionality,
name file with lower case name describing it's generic function.
Example: "dns.hh"