Changes between Initial Version and Version 1 of FpCodingStandardSampleHeader

Timestamp:

May 22, 2015, 4:57:43 PM (9 years ago)

Author:

pesei

Comment:

Create

FpCodingStandardSampleHeader

@@ +1 @@
+
+== Coding standards: Sample header for source code files ==
+
+The header has the following sections:
+  
+  1. GNU License statement. 
+  2. `program|subroutine|function|module|...` statement, possibly followed by a comment line indicating the intent (`i|o|io`) of variables in the parameter list
+  3. Short description of the function of this progamme unit, original author (full name) and date
+  4. List of changes with name or acronym, date, content
+  5. List of (important) variables, including pertinent information such as unit of physical quantities, permitted values, definitions and explanations (if possible in one line per variable
+
+The details of layout and syntax can be taken from the example below. [[BR]]
+Further notes:
+
+  - The first line of the License statement shall look like this
+{{{
+ ! Copyright 1998-20XX
+}}}
+  where 20XX is to be replaced by the year of the last edit. Wherever you still find a list of single years, please replace it.
+
+  - The next 2 lines used to be a list of authors. We have decided to remove it here, Fp authors will be listed elsewhere, either in FLEXPART.f90 or in a separate file.
+
+  - Decorations: Originally all header comment was framed by `*`, 80 chars wides. This had to be changed moving to free format. As it is cumbersome to make a justified r.h.s. line of *, this is not required, but please avoid a ragged line of * (simply leave it open).
+
+
+=== GNU License statement ===
+(without authors, nicer decoration)
+
+{{{
+!***********************************************************************
+!* Copyright 1998-2015                                                 *
+!*                                                                     *
+!* This file is part of FLEXPART.                                      *
+!*                                                                     *
+!* FLEXPART 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.                                 *
+!*                                                                     *
+!* FLEXPART 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 FLEXPART.  If not, see <http://www.gnu.org/licenses/>.   *
+!***********************************************************************
+}}}