Difference between revisions of "Coding style"

From Free Pascal wiki
Jump to navigationJump to search
(→‎Tabulators: Improved text)
m (→‎Misc: Improved markup)
Line 19: Line 19:
 
== Misc ==
 
== Misc ==
  
Please note that the else in consecutive <tt>ifs</tt> isn't indented:
+
Please note that the <tt>else</tt> in consecutive <tt>if</tt>s is not indented:
  
 
  if ... then
 
  if ... then

Revision as of 10:08, 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. Between subroutines are two newlines used to separate 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.