Changes between Version 4 and Version 5 of DevelopmentGuidelines
- Timestamp:
- Feb 7, 2011, 4:57:15 PM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DevelopmentGuidelines
v4 v5 41 41 ||Identifier Type||Rules for Naming||Examples|| 42 42 ||Classes||Class names should be nouns, in mixed case with the first letter of each internal word capitalized. Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations (unless the abbreviation is much more widely used than the long form, such as URL or HTML).||class Raster;class ImageSprite; 43 ||Methods 44 | Methods should be verbs, in mixed case with the first letter lowercase, with the first letter of each internal word capitalized. 45 | run(); 46 runFast(); 47 getBackground(); 48 |- 49 |Variables 50 |Except for variables, all instance, class, and class constants are in mixed case with a lowercase first letter. Internal words start with capital letters. Variable names should not start with underscore _ or dollar sign $ characters, even though both are allowed. 51 43 ||Methods|| Methods should be verbs, in mixed case with the first letter lowercase, with the first letter of each internal word capitalized.|| run(); runFast(); getBackground(); 44 ||Variables|| Except for variables, all instance, class, and class constants are in mixed case with a lowercase first letter. Internal words start with capital letters. Variable names should not start with underscore _ or dollar sign $ characters, even though both are allowed. 52 45 Variable names should be short yet meaningful. The choice of a variable name should be mnemonic- that is, designed to indicate to the casual observer the intent of its use. One-character variable names should be avoided except for temporary "throwaway" variables. Common names for temporary variables are i, j, k, m, and n for integers; c, d, and e for characters. 53 |int i; 54 char c; 55 float myWidth; 56 |} 46 ||int i; char c; float myWidth; 47 || 57 48 58 49 Note: while class names start with an uppercase character, instances of classes are variables and hence start with a lowercase character.