File Headers
Every module should have a header that sits as a comment in the module's definitions area. The header identifies the module and summarizes the external interfaces to it. Here is an example module header:
' ************************************************************** ' Module Startup ' ' Filename tabstart.bas ' Module Prefix St ' ' Author A. Developer ' The Mandelbrot Set (Int'l) Ltd. ' ' Description ' ' Startup module for the table-driven FSM sample application ' ' Revisions ' 11-12-97, A.Developer ' Added instance checking. ' ' 08-12-97, A.Developer ' Moved global FSM object out of here. ' **************************************************************
The module prefix is a two-letter code used as a scope prefix that uniquely identifies this module in the project. Module prefixes are significant only for standard (BAS) modules.