Analytics


Google

Monday, March 17, 2008

Header documentation

I try to make it a practice to have at least the following information as the header of all my programs:

  1. Title
  2. Author
  3. Date Created
  4. Date Revised
  5. Requestor
  6. Objective of the code.
The following is how it is done in Java, C# and PL/SQL

/*
Class Program
Author: Strovek
Date: Mar 01, 2008
Revised: Mar 17, 2008
This is a sample code.
*/

In VB and ASP, it is done as follows:

' Class Program
' Author: Strovek
' Date: Mar 01, 2008
' Revised: Mar 17, 2008
' This is a sample code.


For dos scripts use


REM Author: Strovek
REM Date: Mar 01, 2008
REM Revised: Mar 17, 2008
REM This is a sample code.


No comments: