A Fortran90 module should document all of the module code up to the actual internally defined subroutines or functions (i.e., all that which comes after the F90 keyword CONTAINS. This includes the module name, its public (exported) types, functions and data members, as well as a module description and a revision history.
! ! Use this for your f90 module definition ! !------------------------------------------------------------------------- ! NASA/GSFC, Data Assimilation Office, Code 910.3, GEOS/DAS ! !------------------------------------------------------------------------- !BOP ! ! !MODULE: ! ! !PUBLIC TYPES: ! ! !PUBLIC MEMBER FUNCTIONS: ! ! !PUBLIC DATA MEMBERS: ! ! !DESCRIPTION: ! ! !REVISION HISTORY: ! ! 27Jun97 Jim Becile Initial code. ! !EOP !-------------------------------------------------------------------------
Note that the BOC and EOC markers are not necessary in the module documentation. These markers will most likely occur only within the internal routines.