Changeset 817 for trunk/DOC/BETA/Chapters/Annex_D.tex

Timestamp:

2008-02-09T15:13:48+01:00 (16 years ago)

Author:

gm

Message:

trunk - update including Steven correction of the first 5 chapters (until DYN) and activation of Appendix A & B

File:

• trunk/DOC/BETA/Chapters/Annex_D.tex (modified) (6 diffs)

trunk/DOC/BETA/Chapters/Annex_D.tex

@@ -1 +1 @@
 % ================================================================
-% Chapter Ñ Appendix D : Coding Rules
+% Appendix D Ñ Coding Rules
 % ================================================================
-\chapter{Appendix D : Coding Rules}
+\chapter{Coding Rules}
 \label{Apdx_D}
 \minitoc
 
 
-The "model life" is about ten years and its software, composed by about one 
-hundred programs, is used by many people who are scientists or students and 
+A "model life" is more than ten years. Its software, composed by a few 
+hundred modules, is used by many people who are scientists or students and 
 do not necessary know very well all computer aspects. Moreover, a well 
 thought-out programme is easy to read and understand, less difficult to 
@@ -26 +26 @@
 - flexible.
 
-To satisfy part of these aims, OPA is written with a coding standard which 
-is close to the ECMWF rule, named DOCTOR [Gibson,1986]. These rules present 
-some advantages like :
+To satisfy part of these aims, \NEMO is written with a coding standard which 
+is close to the ECMWF rules, named DOCTOR \citep{Gibson_TR86}. These rules present some advantages like :
 
 - to provide a well presented program
 
-- to enable the extraction of several levels of on-line documentation
-
 - to use rules for variable names which allow recognition of their type 
-(integer, real, parameter, common variables, etc. ) so that debugging is 
+(integer, real, parameter, local or shared variables, etc. ) so that debugging is 
 facilitated.
 
-\textbf{The program structure}
+% ================================================================
+% The program structure
+% ================================================================
+\section{The program structure}
+\label{Apdx_D_structure}
 
 Each program begins with a set of headline comments containing :
@@ -61 +62 @@
 - A program has not more than 200 to 300 lines.
 
-\textbf{Coding conventions}
+% ================================================================
+% Coding conventions
+% ================================================================
+\section{Coding conventions}
+\label{Apdx_D_coding}
 
 - Use of the universal language \textsc{Fortran} 5 ANSI 77, with non 
@@ -106 +111 @@
 - STOP must be well documented with the name of the subroutine or a number.
 
-\textbf{Naming Conventions.}
+% ================================================================
+% Naming Conventions
+% ================================================================
+\section{Naming Conventions}
+\label{Apdx_D_naming}
 
 The purpose of the naming conventions is to use prefix letters to classify 
@@ -117 +126 @@
 \begin{center}
 \begin{tabular}{|p{50pt}|p{50pt}|p{50pt}|p{50pt}|p{50pt}|p{50pt}|p{50pt}|}
+\hline  Type \par / Status &   integer&   real&   logical &   character&   double \par precision&   complex \\  
 \hline
-Type \par / \par Status & 
-integer& 
-real& 
-logical & 
-character& 
-double \par precision& 
-complex \\
-\hline
-global \par or \par common& 
+public & 
 \textbf{m n} \par \textit{but not } \par \textbf{nam}& 
 \textbf{a b e f g h o} \textbf{q} \textit{to} \textbf{x} \par but not \par \textbf{sf}& 
@@ -179 +181 @@
 \end{table}
 %--------------------------------------------------------------------------------------------------------------
-
-\textbf{References}
-
-{\small Gibson, J. K., 1986: Standard software development and maintenance. }{\small \textit{Tech. memorandum}}{\small , Operational Dep., ECMWF, Reading, UK.}
-