wiki:FpCodingStandard

Version 5 (modified by pesei, 8 years ago) (diff)

Use INTENT?

FLEXPART Coding Standards

  1. Explain all variables you use in writing (as comment)
  1. Comment all code
  1. As much as possible, integer variables should have names starting with i,j,k,l,m,n, and don't use real variable names with these initials.
    Typically, i and r or x can be placed in front of any other name to make it conform this specification.
  1. Use indentations for loops, if-statements, etc. From start till end of loop, all code lines should be indented by 2 spaces; nested loops should have multiple indentations so that the looping level is always clear. Because of automatic transcription to F90 standards, a lot of this has been lost and we should try to reintroduce this whereever it has been lost. Indenting by whitespace only, not tab characters (check your editor settings!).
  1. Variables that are passed between subroutines should be marked in the subroutine as input (i), output (o) or both (i/o) when values are changed both in the subroutine and in other routines. This should be done just below the subroutine statement. Again, this has become a mess because of the automatic transcription. We will try to make it systematic again.

Is it also acceptable if an INTENT keyword is present in the declaration section?

  1. If you make changes in a subroutine, explain them in the header: Who? Why? What? When?
hosted by ZAMG