diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index f42abd9d335..ff33ffa98a9 100644 --- a/docs/CodingStandards.html +++ b/docs/CodingStandards.html @@ -60,7 +60,7 @@ loop
Type names (including classes, structs, enums, typedefs, etc) + should be nouns and start with an upper-case letter (e.g. + TextFileReader).
Function names should be verb phrases (as they represent actions), and command-like function should be imperative. The name should be camel case, and start with a lower case letter (e.g. openFile() - or isFoo()). + or isFoo()).
Enum declarations (e.g. "enum Foo {...}") are types, so they +should follow the naming conventions for types. A common use for enums is as a discriminator for a union, or an indicator of a subclass. When an enum is used for something like this, it should have a "Kind" suffix (e.g. - "ValueKind"). + "ValueKind").
Enumerators (e.g. enum { Foo, Bar }) and public member variables should start with an upper-case letter, just like types. Unless the enumerators are defined in their own small namespace or inside a class, enumerators should have a prefix corresponding