next up previous
Next: Testing Up: Documentation Previous: Class Documentation

Function Documenation

All non-trivial functions should have a comment before them describing what they do and how they do it. Small groups of related functions can have a single comment at the beginning of the group. Short details of what each part of a function is doing should be put inside the function. Anything that isn't obvious from a single quick read through the code should be described in the documentation.



Comments: Brian Edward Smits
Wed Apr 23 17:04:33 MDT 1997