Changes between Version 16 and Version 17 of doc/tec/developerrules/palmstandard

Timestamp:

Nov 13, 2018 5:41:05 PM (6 years ago)

Author:

kanani

Comment:

--

doc/tec/developerrules/palmstandard

@@ -213 +213 @@
 }}}
 * '''0 whitespace''' in front of pre-processor directives
-* '''1 whitespace''' before MODULE, CONTAINS, SUBROUTINE (= first indentation level)
-* '''+3 whitespaces''' for all following indentation levels \\(only exception: ONLY list in USE statements '''+4 whitespaces''')\\\\
+* '''1 whitespace''' before {{{MODULE}}}, {{{CONTAINS}}}, {{{SUBROUTINE}}} (= first indentation level)
+* '''+3 whitespaces''' for all following indentation levels \\(only exception: {{{ONLY}}} list in {{{USE}}} statements '''+4 whitespaces''')\\\\
 * '''1 whitespace''' between individual strings, and between strings and symbols/numbers
-* '''1 whitespace''' before and after all operators (+, -, *, =, /)\\(exception: '''0 whitespace''' for ** (exponent operator, e.g. u**2) and operators within expressions for array indices, e.g. u(i+1))
-* '''1 whitespace''' after ''','''\\(only exception: '''0 whitespace''' between array dimensions, e.g. (i,j,k))
-* '''1 whitespace''' before '''::''' \\(at minimum, see Sect. [#align Alignment])
-* '''2 whitespace''' after ''':''' and '''::'''\\\\
+* '''1 whitespace''' before and after all operators (+, -, *, =, /)\\(exception: '''0 whitespace''' for {{{**}}} (exponent operator, e.g. {{{u**2}}}) and operators within expressions for array indices, e.g. {{{u(i+1)}}})
+* '''1 whitespace''' after {{{,}}}\\(only exception: '''0 whitespace''' between array dimensions, e.g. {{{(i,j,k)}}})
+* '''1 whitespace''' before {{{::}}} \\(at minimum, see Sect. [#align Alignment])
+* '''2 whitespace''' after {{{:}}} and {{{::}}}\\\\
 * '''1 blank line''' between enclosed/unrelated blocks of instructions, assignments, clauses, statements, etc.
-* '''2 blank lines''' in front of each SUBROUTINE within a MODULE
+* '''2 blank lines''' in front of each {{{SUBROUTINE}}} within a MODULE
 
 '''__Whitespaces between brackets'''
 (see Fig. 2)
-* '''0 whitespace''' between string and '''('''
-* '''1 whitespace''' after '''(''' and before ''')'''\\(only exception: '''0 whitespace''' for brackets containing array indices)
+* '''0 whitespace''' between string and {{{(}}}
+* '''1 whitespace''' after {{{(}}} and before {{{)}}}\\(only exception: '''0 whitespace''' for brackets containing array indices)
 
 \\\\\\\\\\\\\\\\\\\\\\\\
@@ -238 +238 @@
 * In general: '''1 whitespace''' everywhere and '''3 whitespace''' for each indentation level
 * But: '''2 whitespace'''\\
-  * between '''DO''' and '''loop index'''
-  * after '''IF (  )''' --> see {{{CALL}}}, {{{THEN}}}
-  * in front of and after logical operators (e.g. '''.OR.''', see [#operators list of allowed operators])
+  * between {{{DO}}} and '''loop index'''
+  * after {{{IF (  )}}} --> see {{{CALL}}}, {{{THEN}}}
+  * in front of and after logical operators (e.g. {{{.OR.}}}, see [#operators list of allowed operators])
 
 
@@ -251 +251 @@
 '''Fig. 4''' Alignment example. Click to enlarge.
 }}}
-* Block-wise alignment of continuation line mark '''&'''
-* Alignment of ONLY lists
+* Block-wise alignment of continuation line mark {{{&}}}
+* Alignment of {{{ONLY}}} lists
 * At least block-wise alignment for same type/group of declaration statement
-* Alignment of message_string values
-* Alignment of expressions between brackets (e.g. in '''IF (  )  THEN''' or in argument list of subroutine calls)
-* Alignment of related code, e.g. in complex equations or setting of initial values for variables '''(missing in png)'''
+* Alignment of {{{message_string}}} values
+* Alignment of expressions between brackets (e.g. in {{{IF (  )  THEN}}} or in argument list of subroutine calls)
+* Alignment of related code, e.g. in complex equations or setting of initial values for variables
 
 == (5.3) Alphabetical sorting ==
-* Members in ONLY lists of USE statements (see e.g. Fig. 4)
-* Parameters in NAMELISTS (see e.g. initialization_parameters NAMELIST in parin.f90)
-* Declaration types (first CHARACTERs, then INTEGERs, etc., see Fig. 4)
+* Members in {{{ONLY}}} lists of USE statements (see e.g. Fig. 4)
+* Parameters in {{{NAMELISTS}}} (see e.g. initialization_parameters NAMELIST in parin.f90)
+* Declaration types (first {{{CHARACTER}}}, then {{{INTEGER}}}, etc., see Fig. 4)
 * Variables in declaration statements (see Fig. 4)