Changes between Version 2 and Version 3 of doc/tec/developerrules/palmstandard

Timestamp:

Nov 2, 2018 6:01:39 PM (6 years ago)

Author:

kanani

Comment:

--

doc/tec/developerrules/palmstandard

@@ -1 +1 @@
 = PALM coding rules =
-This is.....\\
+Why to follow some standards? - Because everyone has her/his own programming style, sort of a dialect. And as it is, no one can understand all the possible dialects. So what do we do? We learn and apply the coding standard to make PALM more easily readable for all current and future developers. Let's all work on that - together.
 
-'''Why to follow some standards?''' - Because everyone has her/his own programming style, sort of a dialect. And as it is, no one can understand all the possible dialects. So what do we do? We learn and apply the coding standard to make PALM more easily readable for all current and future developers. Let's all work on that - together.
+== General ==
+* Only ASCII characters allowed ('''no:''' °, ^2^, µ, etc.)
+* Line length limit: 80 (soft) | 120 (hard)
+*
 
-== Indenting ==
-'''General module structure'''
-* 1 blank before MODULE, CONTAINS, SUBROUTINE (= first indention level)
-* +3 blanks for all following indention levels \\('''only exception:''' ONLY list in USE statements +4 blanks)
-* 1 blank between individual strings
-* 1 blank after ","
-* 1 blank before "::"
-* 2 blanks after ":"
+== Indenting & spaces ==
+=== General module structure ===
 {{{
- MODULE new_module_mod
-
-    USE arrays_3d,                                                        &
-        ONLY:  tend, u, v, w, zu, zw
-
-    IMPLICIT NONE
-
-    CHARACTER ::  global_string_a
-
-    SAVE
-
-    PRIVATE
-
-    PUBLIC global_string_a
-
-    INTERFACE newmod_3d_data_averaging
-       MODULE PROCEDURE newmod_3d_data_averaging
-    END INTERFACE newmod_3d_data_averaging
-
- CONTAINS
-
- SUBROUTINE newmod_3d_data_averaging( mode, variable )
-
-    USE control_parameters
-
- END SUBROUTINE newmod_3d_data_averaging
-
- END MODULE new_module_mod
+#!div style="align:'left'; width: 500px; border: 0px solid; float:right"
+[[Image(rules_indent_general.png, 500px, right, margin-right=2, margin-top=0, border=0)]]\\
+Indention example with highlighted whitespaces. Click to enlarge.
 }}}
 
-== Sorting ==
+* '''1 whitespace''' before MODULE, CONTAINS, SUBROUTINE (= first indention level)
+* '''+3 whitespaces''' for all following indention levels \\(only exception: ONLY list in USE statements '''+4 whitespaces''')\\
+
+
+* '''1 whitespace''' between individual strings
+* '''1 whitespace''' after ''','''
+* '''1 whitespace''' before '''::'''
+* '''2 whitespace''' after ''':'''
+
+
+=== Whitespaces between brackets ===
+* '''0 whitespace''' between string and '''('''
+* '''1 whitespace''' after '''(''' and before ''')'''
+
+\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
+== Alphabetical sorting ==
 except for CALLs to modules/subroutines
+
+== Lower/upper case ==
 
 == Commenting ==