Changes between Version 19 and Version 20 of DeveloperGuidelines/CodeConventions

Timestamp:

06/21/11 14:21:26 (13 years ago)

Author:

Mike A

Comment:

added notes on naming conventions

DeveloperGuidelines/CodeConventions

@@ -24 +24 @@
  * All functions outside of classes should have the prefix shn_<Model Name>_
  * All classes which over-ride existing classed should have the suffix "S3"
+ * Names should be obvious and explicit, but not overly verbose (i.e. as long as they need to be to not make people think). They shouldn't require someone to look in another file or solve a puzzle to figure out what they mean, but shouldn't take too long to write. Avoid inventing new acronyms. e.g. bad: {{{ shn_prm_lkp, method_that_allows_us_to_create_a_gis_layer }}}, good: {{{ shn_personnel_search, create_gis_layer }}}
 
 == Comments and Docstrings ==