What is the difference between “internal” and “external” documentation?
NOTE: Remember that an “acceptable” program must: • include documentation (both internal and external); in order of priority, BE CLEAR, PRECISE, and CONCISE! • Minimal external documentation is hardcopy (or a Web page for HTML/Applets) that includes (1) FILENAME, (2) STUDENT NAME:, (3) LANGUAGE/VERSION: (e.g. LANGUAGE/VERSION: Java 2 with JBuilder 9.0), (4) DATE COMPLETED:, (5) DATE LAST MODIFIED:, (6) DESCRIPTION: (7) HOW TO EXECUTE: plus a printout of the code. • Minimal internal documentation should include comments on code that is not self explanatory. However, do not be excessive; be concise! • For your own sake, 10 years from now, you should also specify the course and instructor for whom it was written, reasons for the assignment, concepts illustrated, ideas for improvement, modification, extensions, etc., and whatever else that will help you benefit from relooking at the program. • be modular and self documenting (readable with meaningful module names), • pass parameters (where
