Changes between Version 7 and Version 8 of DevelopmentGuidelines


Ignore:
Timestamp:
Feb 7, 2011, 5:00:55 PM (9 years ago)
Author:
jannekevdp@…
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DevelopmentGuidelines

    v7 v8  
    2929== Tabs & Indentation ==
    3030 * use the following settings for tabbing and indentation
    31 [[Image:Screen shot 2009-11-02 at 3.10.53 PM.png]]
     31[[Image(screenshot2.png)]]
    3232
    3333== Subversion commits ==
     
    4242||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;
    4343||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. 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.
    45 ||int             i; char            c; float           myWidth;||
     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. 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.||int             i; char            c; float           myWidth;||
    4645
    4746Note: while class names start with an uppercase character, instances of classes are variables and hence start with a lowercase character.