On May 11, 5:58=A0pm, Stefan <stefan@[EMAIL PROTECTED]
> wrote:
> When writing programs/subroutines I usually give them 'header' like
> this:
>
> PROGRAM/SUBROUTINE EXAMPLE(a,b,...)
> ! Version: 1.01 =A0 =A0 Last modified: 11.01.2001.
> ! Parameters: a - first parameter
> =A0 =A0 =A0 =A0 =A0 =A0 =A0 b - second -||-
> ! Calling: list of subroutines it calles, if any ...
> ! Part of: if part of a greater program (exclusivly)
> ! Compiled and tested with: CVF66c
> ! Modifications:
> ! - version number / date:
> ! =A0 short description of modification
>
> Do you have a similar habit and what do you include in those headers?
> How do you organize larger programs and determine what a certain
> subroutine does after not looking at it for a while ?
>
> Stefan
Most collections of routines have similar headers. Look at the source
files for any large collection of routines such as those on Netlib as
examples. Also look at their classification scheme (like GAMS) as a
way of organizing routines. Manuals for commercial libraries are also
available on the net, so you could look at those too.
Otherwise, I have two suggestions.
1. do whatever your organization does.
2. follow the instructions of he who writes your paycheck. :-).
- e
|
