Changes between Version 4 and Version 5 of doc/tec/developerrules/palmstandard

Timestamp:

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

Author:

kanani

Comment:

--

doc/tec/developerrules/palmstandard

@@ -5 +5 @@
 * Only ASCII characters allowed
 * Line length limit: 80 (soft) | 120 (hard)
-*
 
-== Indenting, spaces & alignment ==
-=== General module structure ===
+== Indenting, spaces & line breaks ==
+=== General module/subroutine structure ===
 {{{
-#!div style="align:'left'; width: 400px; border: 0px solid; float:right"
-[[Image(rules_indent_general.png, 400px, right, margin-right=2, margin-top=0, border=0)]]\\
-Indention example with highlighted whitespaces. Click to enlarge.
+#!div style="align:'left'; width: 450px; border: 0px solid; float:right"
+[[Image(rules_indent_general.png, 450px, right, margin-right=2, margin-top=0, border=0)]]\\
+Fig. 1 Indention example with highlighted whitespaces. Click to enlarge.
 }}}
 
+* '''0 whitespace''' in front of pre-processor directives
 * '''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, and between strings and symbols/numbers
+* '''1 whitespace''' after ''','''\\(only exception: '''0 whitespace''' between array dimensions)
+* '''1 whitespace''' before '''::''' \\(at minimum, see Sect. [#align Alignment])
+* '''2 whitespace''' after ''':''' and '''::'''\\
 
-* '''1 whitespace''' between individual strings
-* '''1 whitespace''' after ''','''
-* '''1 whitespace''' before '''::''' \\(at minimum, see Sect. [#align Alignment])
-* '''2 whitespace''' after ''':'''
-
+* '''1 blank line''' between enclosed instructions, assignments, clauses, statements, etc.
+* "&" minimum at 80, max at 120
 
 === Whitespaces between brackets ===
 * '''0 whitespace''' between string and '''('''
-* '''1 whitespace''' after '''(''' and before ''')'''\\(only exception: '''0 whitespace''' in declaration statements)
+* '''1 whitespace''' after '''(''' and before ''')'''\\(only exception: '''0 whitespace''' in dimensions)
 
-=== Alignment ===
+=== Whitespaces in DO, IF blocks ===
+
+\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
+== Alignment ==
 * Linebreaks
 * ONLY lists
+* at least block-wise alignment for same type of declaration
+* of messages
 
 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
@@ -43 +49 @@
 == Naming conventions ==
 
+== Operators ==
+* e.g. /=, <, <=, ==, >, >=, etc. (not .GE., .LT., etc)
+* .AND., .OR., .NOT.
 
-== New modules ==
-'''File header'''
+== File header ==
 * Files always start with a doxygen-readable comment line including the FORTRAN file name.
 * This is followed by the license section. If your code originates from another model, please clarify the license and permissions for this code to enter the PALM model system. It might be necessary in that case to add some more information to this header.
 * The revisions section will later include short notes of the changes applied to a specific svn revision of this file. The {{{$Id$}}} string is required so that svn knows to generate the respective time stamp for a revision (see existing SOURCE files).
 * Finally, involved authors are included, followed by a description of the purpose and functions of the module. If necessary, TODOs, notes and known bugs can be added. The "!>" indicate doxygen-readable comment lines, the "@" marks doxygen variables.
-{{{
-!> @file new_module_mod.f90
-!-----------------------------------------------------------------------------!
-! This file is part of the PALM model system.
-!
-! PALM is free software: you can redistribute it and/or modify it under the
-! terms of the GNU General Public License as published by the Free Software
-! Foundation, either version 3 of the License, or (at your option) any later
-! version.
-!
-! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
-! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
-!
-! You should have received a copy of the GNU General Public License along with
-! PALM. If not, see <http://www.gnu.org/licenses/>.
-!
-! Copyright 2018-2018 Leibniz Universitaet Hannover, <your institution>
-!-----------------------------------------------------------------------------!
-!
-! Current revisions:
-! -----------------
-! Initial revision
-! 
-! Former revisions:
-! -----------------
-! $Id$
-!
-! Authors:
-! --------
-!> @author <Author 1> (<Affiliation>)
-!> @author <Author 2> (<Affiliation>)
-!
-!
-! Description:
-! ------------
-!> <Description of the new module>
-!>
-!>
-!> @todo <Enter things that remain to be done>
-!> @note <Enter notes on the module>
-!> @bug  <Enter known bugs here>
-!------------------------------------------------------------------------------!
-}}}