RE: [sqr-users] Comment Headers

["Alexander, Steve" <Steve.Alexander@ci.sj.ca.us>]

Here are some ideas as to what to put in a comment block.  I doubt anybody
uses all of them.  Think about the readers; someone having to fix a bug at 2
AM, someone trying to add a feature, someone trying to understand what the
program does or why it does it, etc.

Name of program

Description of program

Name of organization that owns the program

Copyright notice

The business owners, customers, requestors, or users within the organization
for this program

The functional analysts who specified the program

The system analysts who specified the program

The path and file name for any related documents; functional specs,
technical specs, test plans, meeting minutes, explanatory spreadsheets, etc.

The programmers who wrote the program

The code or number that identifies the request for the program

The significant dates in the history of the program (requested, began
coding, put into production, etc.)

The Peoplesoft menu path for running the program, or the method for running
the program in some other system

A list of the database tables that the program uses and how they're used
(i.e. select, insert, update, delete)

A list of the disk files that the program uses and how they're used (i.e.
read, write)

An explanation of the user supplied values that the program uses (i.e. as of
date)

An explanation of the flags or switches that the program uses (i.e. what
does $found mean)

Maintenance history with who, when, what, and why - including the code or
number that identifies the request for the change, and the version number of
the program.

-----Original Message-----
From: Hunsaker, Michael S [mailto:mhunsake@indiana.edu]
Sent: Wednesday, September 17, 2003 12:02 PM
To: sqr-users@sqrug.org
Subject: [sqr-users] Comment Headers


Hello -
 
I am beginning to learn SQR and in order for me to keep track of my programs
(and for others to use them), I would like to have a nicely formatted header
with comments about the program.  I guess I could write the author name and
program desciption but figured I would ask if anyone had a more in-depth
header file that I could copy for my programs.  I have seen a few very good
comment headers in the past but cannot locate them again.
 
Thanks in advance.
 
Michael Hunsaker
Indiana University Bloomington

_______________________________________________
sqr-users mailing list
sqr-users@sqrug.org
http://www.sqrug.org/mailman/listinfo/sqr-users

_______________________________________________
sqr-users mailing list
sqr-users@sqrug.org
http://www.sqrug.org/mailman/listinfo/sqr-users