Changes between Version 7 and Version 8 of CodingConventions


Ignore:
Timestamp:
Mar 24, 2009, 3:22:11 PM (16 years ago)
Author:
Gavin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • CodingConventions

    v7 v8  
    11== Coding Conventions ==
    22
    3 Coding conventions are a preffered way of doing things.
     3Coding conventions are a preferred way of doing things.
    44
    55'''Files'''
    … …  
    2424This way the original views are available as direct access to the data for administration. If the domain changes enough a "grails generate-all" can be performed on most domains without losing the customisations. Proposed suffix 'Detailed as in detailing a car, customised or air-brushed, unless a better suffix is suggested.
    2525
     26'''Documentation'''
     27
     28The documentation is along side the source for good reason they need to be kept in sync. Document and code simultaneously. If you code a feature, document it as you go or better still design the feature by using the documentation then code and document as you go. This way the two are really not that different. Use self documenting code, don't abbreviate: ''!LinIntDist'' could mean a lot of things ''!LinthianInternalDistortion'' is a lot more clear.