next up previous contents index
Next: 5.4.2 Header of modules Up: 5.4 Comments Previous: 5.4 Comments   Contents   Index

5.4.1 Header of files

The header of a file should contain a short summary of its contents, as for example:

!****************************************************************************************************
!
!   #####   #    #  #####          #    #  #   #  #####
!   #    #  #    #  #    #         #    #   # #   #    #
!   #    #  ######  #    #         ######    #    #    #
!   #####   #    #  #    #         #    #    #    #    #
!   #   #   #    #  #    #         #    #    #    #    #
!   #    #  #    #  #####  ####### #    #    #    ##### _module
!
!   Radiation-Hydrodynamics Code: hydrodynamics module
!
!****************************************************************************************************
!   Fortran90
!   2015-04-04
!****************************************************************************************************
! With contributions from:
!   Bernd Freytag:         Kiel, Copenhagen, Uppsala, Montpellier, Lyon, Naples
!   Werner Schaffenberger: Exeter
!   Sven Wedemeyer-Boehm:  Freiburg
!****************************************************************************************************
! MODULES:
!   rhd_hyd_module:        Hydrodynamics routines
!
!****************************************************************************************************

Dates should be written in the form YYYY-MM-DD. The date in the header should be updated each time a file is edited. The banner at the top can be generated, e.g., with the ASCII Generator (Font=banner, Width=100). Usually, a file contains one module with more detailed information in its respective header.


next up previous contents index
Next: 5.4.2 Header of modules Up: 5.4 Comments Previous: 5.4 Comments   Contents   Index