C Coding Standards for Functions

http://www.cs.umbc.edu/courses/undergraduate/201/spring01/projects/codingstd.shtml is the course webpage on C Coding Standards.

Each function must have a Function Header Comment Containing the Following:

  1. function name
  2. a description of what the function does
  3. a description of the function's inputs
  4. a description of the function's outputs
  5. side effect of the function (if any -- this should be rare)
For Example:
/************************************************ ** CircleArea -- ** This function calculates the area of a circle ** with the specified radius ** Inputs: the circle's radius as a parameter ** Output: the circle's area as the return value **************************************************/

Main Page Previous