Self Documenting Code Check List: Classes: Does the class interface present a consistent abstraction? Is the class well named? Does the name describe the central ...
classx Is used to generate fitting values for each point in mesh. For each point, it generates a 1-ring 2-ring neighborhood around that point. Then it does a plane ...
This page is a coding guide for TMV developers Environments The various platforms tools we use to develop solutions Statement our main goals with TMV Guide Our ...
Place to keep track of (and argue about) flag names Common flags $ i: input file or format including spa, smb, txt, raw f, raw d, tgz ... $ o: output file or format ...
To Comment or Not to Comment: Don't Comment Arguments: (write self-documenting code) Poorly written or incorrect comments are worse than no comments at all. Clearly ...
Commenting Classes Describe the design approach to the class Describe limitations, usage assumptions, and so on Comment the class interface, can someone easily understand ...
Commenting Control Structures if , case , loops , or long blocks of statements are natural insertion points for summary comments Comment the end of control structures ...
Commenting Data Declarations Comment the units of numeric data Comment the range of allowable numeric values Use enumerations instead of magic numbers or magic strings ...
Commenting Files Describe the purpose and contents of each file in a block comment at beginning of file Put author contact information in the file block comment Include ...
Commenting Paragraphs of Code Write comments at the level of the code's intent Focus your documentation efforts on the code itself Focus your paragraph comments on ...
Commenting Programs Include a Usage document (Readme) that explains how to use the program via command line paramters, menu commands, keyboard shortcuts, and/or mouse ...
Commenting Routines Keep comments close to the code they describe Describe each routine in one or tow simple sentences at the top of the routine Document parameters ...
General Guidelines when it comes to using comments These sections are based on the book "Code Complete 2", Chapter 32, Self-Documenting code Arguments Pro Con of ...
TOC Problem statement Marc van Kreveld asks, given a set of n points, how many combinatorially different Delaunay triangulations can you get if you are allowed to ...