File: CodingStyle.txt

package info (click to toggle)
ray 2.3.1-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,008 kB
  • sloc: cpp: 49,973; sh: 339; makefile: 281; python: 168
file content (37 lines) | stat: -rw-r--r-- 710 bytes parent folder | download | duplicates (5)
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
== Indent style ==

* Kernighan and Ritchie style, variant "The One True Brace Style" (1TBS)
	http://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS

* With TAB symbols.

== New lines ==

* Only use '\n'

== Symbols ==

* Class names are names, not verbs.
* Method names are verbs, not names.

* Attribute members of a class are prefixed with 'm_'.

* No acronyms (except mpi).

* Slave modes are prefixed with 'RAY_SLAVE_MODE_'.

* Master modes are prefixed with 'RAY_MASTER_MODE_'.

* Message-passing interface tags are prefixed with 'RAY_MPI_TAG_'.

== Headers ==

Include the headers in this order:

* plugin headers
* other plugin headers
* RayPlatform headers
* C++ headers
* C headers
* POSIX headers