Coding Conventions: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Keine Bearbeitungszusammenfassung |
|||
| Zeile 7: | Zeile 7: | ||
Hierbei werden zum Beispiel Namenskonventionen und ihre Schreibweise ausgemacht. Aber auch auf die Einrückungstiefe des Quellcodes, das Benutzen von Leerzeichen oder Tabstopps sowie andere Richtlinien bei der Codeerstellung kann hier eingegangen werden. | Hierbei werden zum Beispiel Namenskonventionen und ihre Schreibweise ausgemacht. Aber auch auf die Einrückungstiefe des Quellcodes, das Benutzen von Leerzeichen oder Tabstopps sowie andere Richtlinien bei der Codeerstellung kann hier eingegangen werden. | ||
=== Naming Conventions | === Naming & Style Conventions === | ||
In diesem Abschnitt wird beschrieben nach welchen Regeln Klassen, Typen, Variabeln usw. | In diesem Abschnitt wird beschrieben nach welchen Regeln Klassen, Typen, Variabeln usw. | ||
benannt werden müssen. | benannt werden müssen. | ||
| Zeile 73: | Zeile 73: | ||
*Benutze Paare bestehend aus einem Verb und dem Objektname z.B. '''ShowDialog()'''. | *Benutze Paare bestehend aus einem Verb und dem Objektname z.B. '''ShowDialog()'''. | ||
*Methoden die einen Wert zurückgeben, sollte eine Beschreibung des Wertes im Namen haben z.B. '''GetObjectState()'''. [[Kategorie:Code-Beispiele]] | *Methoden die einen Wert zurückgeben, sollte eine Beschreibung des Wertes im Namen haben z.B. '''GetObjectState()'''. | ||
===== Variabeln ===== | |||
Regeln für das Sinnvolle benennen von Variabeln: | |||
*Verwende anschauliche Namen | |||
**Verwende '''keine''' Buchstaben als Variablennamen wie z.B. i oder t. Benutze stattdessen index oder temp. | |||
**Verwende '''keine''' [http://de.wikipedia.org/wiki/Ungarische_Notation|HungarianNotation] | |||
**Verwende '''keine''' Abkürzungen z.B. num statt number. | |||
=== Coding Style === [[Kategorie:Code-Beispiele]] | |||
