Difference between revisions of "Coding style"
m (→Newlines: Improved and cllarified text) |
(→Newlines: Marked unclear text.) |
||
| Line 15: | Line 15: | ||
== Newlines == | == Newlines == | ||
| − | Newlines are set as it is done by most Object Pascal programs. Subroutines separated by three newlines, | + | Newlines are set as it is done by most Object Pascal programs (what does this mean? advice: avoid passive voice). |
| + | Subroutines separated by three newlines, | ||
that is, there are ''two'' blank lines between them. | that is, there are ''two'' blank lines between them. | ||
Revision as of 11:15, 21 January 2008
Introduction
Some people might think that the coding style used by the FPC compiler sources and base rtl is a little bit strange but it has been used for a lot of years and isn't subject to be discussed. So take the following as a standard to be used.
Keywords
All keywords are written in lower case. There is no need to make them unreadble by writing them upper case. Modern IDEs support highlighting so keywords will be recognized.
TAB characters
Do not use TAB characters (ASCII HT, 0x09). There is no standard default TAB setting, so the look of source files using TAB characters will depend on client settings. This may result in a chaotic view of source files. Align by space characters (also see Indentation).
Indentation
Indentation size is always 2 space characters per level.
Newlines
Newlines are set as it is done by most Object Pascal programs (what does this mean? advice: avoid passive voice). Subroutines separated by three newlines, that is, there are two blank lines between them.
Misc
Please note that the else in consecutive ifs is not indented:
if ... then else if ... then else if ... then
Examples
How it looks like can be easily checked by having a look at the FPC sources.
