diff --git a/CODING_STANDARDS b/CODING_STANDARDS index 5cf70c92b5f5a..74652c9b22034 100644 --- a/CODING_STANDARDS +++ b/CODING_STANDARDS @@ -151,19 +151,36 @@ User Functions/Methods Naming Conventions 'buildsomewidget' 'getI()' -7. Classes should be given descriptive names. Avoid using abbreviations where +7. Class names should be descriptive nouns in PascalCase and as short as possible. Each word in the class name should start with a capital letter, - without underscore delimiters (CamelCaps starting with a capital letter). - The class name should be prefixed with the name of the 'parent set' (e.g. - the name of the extension):: + without underscore delimiters. The class name should be prefixed with the + name of the "parent set" (e.g. the name of the extension) if no namespaces + are used. Abbreviations and acronyms as well as initialisms should be + avoided wherever possible, unless they are much more widely used than the + long form (e.g. HTTP or URL). Abbreviations, acronyms, and initialisms + follow the same letter-casing as any other word. Good: 'Curl' - 'FooBar' + 'CurlResponse' + 'HttpStatusCode' + 'Url' + 'BTreeMap' (B-tree Map) + 'Id' (Identifier and Identity Document) + 'Char' (Character) + 'Intl' (Internationalization) + 'Radar' (Radio Detecting and Ranging) Bad: - 'foobar' - 'foo_bar' + 'curl' + 'curl_response' + 'HTTPStatusCode' + 'URL' + 'BtreeMap' + 'ID' + 'CHAR' + 'INTL' + 'RADAR' Internal Function Naming Conventions ----------------------