EAC - Voluntary Voting System Guidelines

Name : | Ian S. Piper
Organization : | Diebold Election Systems, Inc.
Post Date : | 9/29/2005
Section Comments
Section : | 4.2.7
Page no. : | 4-7
Line no.: |
Comment : | In respect to the requirement in item (b), "All variables shall have comments at the point of declaration clearly explaining...", there needs to be a qualification that reads "except where the purpose of the variable is made explicit by its name". Otherwise source code will contain comments such as, "int linenumber = 0; // the line number", which serve no useful purpose except to promote inefficiency. Proposed change: Replace the language "All variables shall have comments at the point of declaration clearly explaining..." with "All variables shall have comments at the point of declaration, except where the purpose of the variable is made explicit by its name, clearly explaining..."