diff options
Diffstat (limited to 'CODING_STANDARDS')
| -rw-r--r-- | CODING_STANDARDS | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/CODING_STANDARDS b/CODING_STANDARDS index 9feb43b851..bf9854b7cd 100644 --- a/CODING_STANDARDS +++ b/CODING_STANDARDS @@ -133,7 +133,22 @@ Naming Conventions [5] Variable names should be in lowercase. Use underscores to separate between words. -[6] Classes should be given descriptive names. Avoid using abbreviations +[6] Method names follow the 'studlyCaps' (also referred to as 'bumpy case' + or 'camel caps') naming convention, with care taken to minimize the + letter count. The initial letter of the name is lowercase, and each + letter that starts a new 'word' is capitalized. + + Good: + 'connect()' + 'getData()' + 'buildSomeWidget()' + + Bad: + 'get_Data()' + 'buildsomewidget' + 'getI()' + +[7] Classes should be given descriptive names. Avoid using abbreviations where possible. Each word in the class name should start with a capital letter, with words underscore delimited. The class name should be prefixed with the name of the 'parent set'. |