NC -- Namenskonventionen
Nach oben zu C++-Audits
Beschreibung
NC prüft, ob der Code den Benennungsrichtlinien entspricht. NC überprüft:
- Die Verwendung von Großbuchstaben bei internen Elementen von zusammengesetzten Bezeichnern, wenn Elemente ohne Leerstellen verbunden werden.
- Die Verwendung von Präfixen in Bezeichnern.
NC überprüft die Großschreibung bei folgenden Bezeichnertypen:
Bezeichnertyp | Beschreibung |
---|---|
NCCheckClassNames |
Klassennamen. Die Vorgabe ist |
NCCheckEnumeratorNames |
Enumeratornamen. Die Vorgabe ist |
NCCheckFieldNamesConst |
Namen von nicht veränderbaren Feldern. Die Vorgabe ist |
NCCheckFieldNamesOthear |
Namen von veränderbaren Feldern. Die Vorgabe ist |
NCCheckFieldNamesPublic |
Namen von public-Feldern. Die Vorgabe ist |
NCCheckFieldNamesStatic |
Namen von statischen Feldern. Die Vorgabe ist |
NCCheckFunctionNames |
Funktionsnamen. Die Vorgabe ist |
NCCheckLocalVariablesFormalParameterNames |
Namen von lokalen Variablen und formalen Parametern (Argumenten). Die Vorgabe ist |
NCCheckMacroNames |
Namen von Makros. Die Vorgabe ist |
NCCheckMethodNames |
Namen von Methoden. Die Vorgabe ist |
NCCheckNamespaceNames |
Namen von Namespaces. Die Vorgabe ist |
NC kann mit den folgenden Typen von Schreibweisen arbeiten:
Schreibweise | Beschreibung |
---|---|
|
Jeder Anfangsbuchstabe eines internen Elements sollte in einem zusammengesetzten Bezeichner groß geschrieben und der erste Buchstabe des Bezeichners klein geschrieben sein, z.B. iPod. |
|
Alle Buchstaben eines Bezeichners sollten klein geschrieben sein. |
|
Jeder Anfangsbuchstabe eines internen Elements sollte in einem zusammengesetzten Bezeichner groß geschrieben und der erste Buchstabe des Bezeichners groß geschrieben sein, z.B. BackColor. |
|
Alle Buchstaben eines Bezeichners sollten groß geschrieben sein. |
NC überprüft die Präfixe bei folgenden Bezeichnertypen:
Bezeichnertyp | Beschreibung |
---|---|
NCPrefixClassFieldNames |
In Feldnamen in Klassen |
NCPrefixClassNames |
In Namen von Klassen |
NCPrefixEnumeratorNames |
In Namen von Enumeratoren |
NCPrefixInstanceFieldName |
In Feldnamen in Objekten |
Falsch:
class myClass {
static const int max_size = 10;
void MyMethod() {
int Var;
}
};
Richtig:
class MyClass {
static const int MAX_SIZE = 10;
void myMethod() {
int var;
}
};
Refactoring
Mit dem Menübefehl Refactor > Umbenennen können Sie Namen umbenennen.