c - FUNCTION ORGANIZATION

[nixawk]

[nixawk]

Function Prologs

Every function should have a function prolog to introduce the function to the reader.
The function prolog should contain the following information:

• Function name

  • One or more words all in lower case and separated by underscores
  • Upper case OK if name includes a proper noun (e.g.,
    Gaussian_distribution)
  • Followed by brief descriptive comment

• Arguments listed one per line with the type, I/O, and a brief description

• Return value describes what the function returns

Example: function prolog

/********************************************************
*                                                       *
* FUNCTION NAME:                                        *
*                                                       *
* ARGUMENTS:                                            *
*                                                       *
* ARGUMENT TYPE I/O DESCRIPTION                         *
* -------- ---- --- -----------                         *
*                                                       *
* RETURNS:                                              *
*                                                       *
*********************************************************/