UNIVERSITY OF THE WESTERN CAPE

Department of Computer Science

Code Document

You are expected to fully document your code. Every class and class method should have a name, a brief one-line description, and a detailed description of the algorithm. All methods also require descriptions of all inputs and outputs. If applicable, you should also note any caveats - things that could go wrong or things that the code doesn't address. Put assumptions in the caveats section. If you are coding in Java, you should use the documentation tags that work with the javadoc utility. This utility automatically generates web pages for your documentation. To make things consistent, simply cut and paste the textual descriptions of your classes, objects, and methods from your OOD directly into the code. Then let javadoc do the dirty work. If you are not coding in Java, you can still use the same tags and see if javadoc operates on your source files. Otherwise, you could write such a utility yourself!

News Headlines

Zenzeleni - Mozilla Equal Rating
10 Mar 2017 13:18

Zenzeleni has a chance to win Mozilla Foundation’s Equal Rating Innovation Challenge!   Part  [ ... ]

Previous News