Your code must incorporate a consistent, well-documented style. Required points of style include:
? Include clear, concise, and adequate inline comments
? Write substantive, descriptive blocks for each module
? Write a substantive, descriptive block for the entire program.
? Comments should describe the function performed, not restate the code in English.
? Comments should explain the purpose of a function or method, its inputs, and outputs.
? Comments should explain the algorithm being applied, a particular approach to a problem, or restrictions in using the code
? Use white space liberally.
? Write one driver that executes your entire code.
? Consistent, well-delineated use of both upper and lower case is encouraged.
? Using indentation to show nesting of control statements is encouraged.
? Set tabs to only 2-3 spaces and keep line lengths to about 78 columns to reduce wrap around.
? Keep code modular. One page is a good rough guide to module size.
? Do not use GOTOs or global variables
? Use include files so that a link step is not necessary.
The post Your code must incorporate a well-documented style. appeared first on My Assignment Online.
