File: CodingStyle

package info (click to toggle)
njamd 0.9.3pre2-4
  • links: PTS
  • area: main
  • in suites: woody
  • size: 1,704 kB
  • ctags: 1,056
  • sloc: ansic: 9,367; sh: 7,921; makefile: 121; perl: 52
file content (31 lines) | stat: -rwxr-xr-x 879 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
OK, this may be a contentious point, but I think we should all probably
follow some guidelines for consistency.  Here are some ideas:

--
Every header should be enclosed in the following block:

#ifndef __NJAMD_<directory>_<header file name>_H__
#define __NJAMD_<directory>_<header file name>_H__

#endif /* __NJAMD_<directory>_<header file name>_H__ */

<directory> is any subdirectory under src.  For example,

#ifndef __NJAMD_FE_FE_H__
...

or

#ifndef __NJAMD_LIB_MEM_H__

--
Indentation is in ALL tabs, not spaces.  For multiple-line commands, 
every line after the first should have the same indentation, one more
level than the first.

--
To avoid namespace pollution, we will prefix everything with __nj.
--
If you create your own file, you may use your own coding style within these
boundries. When working within someone else's file, please code in their
coding style.