Variablen, Methoden uvm logisch benennen!

Hallo,
in diesem Tutorial möchte ich ein paar Varianten der Methoden-, Funktions- und Variablenbenennung zeigen. Ich wünsche viel Spaß und hoffe, dass ihr alles versteht.

• Wieso Dinge nach einer Konvention benennen?
Dies liegt klar in der Hand. Wenn den Code über längere Zeit behält oder veröffentlicht, dann kann man mit der Variable "a" weniger verbinden als beispielsweise mit "playerAmmo". Es ist immer ein lustiges Such- und Findespiel, sollte man solche Variablen haben. Deshalb sollte man bei der Benennung von Variablen Acht geben und möglichst eine Konvention einhalten.

• Was gibt es für Konventionen?
Ich möchte euch kurz vier Konventionen vorstellen, mit der man Variablen, Methoden, Funktionen, Klassen uvm benennen kann.

- Camel Case:
Dies ist eine Konvention, die durch Java, C# und viele mehr bekannt wurde. Bedingung ist, dass der erste Buchstabe immer klein ist. Sollte der Name 2 Wörter enthalten, so wird der Anfangsbuchstabe des zweiten Wortes groß geschrieben.
Beispiel: "spielerGeld", "istSpielerAdmin"

- Pascal Case:
Diese Konvention wurde u.a. durch Pascal und Visual Basic bekannt. Es ähnelt der Camel Case-Konvention, doch schreibt man den ersten Buchstaben groß.
Beispiel: "SpielerGeld", "IstSpielerAdmin"

- Konvention für "C":
Diese Konvention hat keinen eigenen Namen, doch wird sie größtenteils bei der Programmier- und Hochsprache "C" benutzt. Hierbei trennt man mehrere Wörter mit einem Unterstrich. Dies kann beliebig mit Groß- und Kleinschreibung kombiniert werden.
Beispiel: "spieler_Geld", "ist_SPIELER_admin"

- Konvention 4:
Diese Konvention hat ebenfalls keinen Namen. Sie wird u.a. bei COBOL genutzt. Hierbei werden Wörter mit Bindestriechen getrennt. Doch ist zu beachten, dass sie nicht als Subtraktions Operator gelten. Dies kann ebenfalls beliebig mit Groß- und Kleinschreibung vermischt werden, doch ist die dauerhafte Großschreibung am geläufigsten.
Beispiel: "SPIELER-GELD", "IST-SPIELER-ADMIN"

- Ungarische Notation:
Danke an Goldkiller. Klick hier für weitere Informationen....
Beispiel: "new sString[128]", "new Text:tdTextdraw"

• Welche Konvention ist die beste für Pawn?
Für Pawn würde ich Pascal Case empfehlen, da die meisten Pawn eigenen Befehle auch in dieser Konvention angeordnet sind. Doch ist es frei wählbar.

Danke an euch Beide.

Zitat von Goldkiller

Ich sehe irgendwie nicht, wo du auf Variablen explizit eingehst.

Ungarische_Notation
Find ich persöhnlich ganz praktisch, besonders für Variablen.
Es lässt 1:1 auf Pawn beziehen,da alle Variablen technisch vom gleichen Typ sind. Lässt sich aber mMn dennoch abstrakt dafür verwenden.

new sString[] = "String"; // oder sz,wie man es halt möchte
new Float:fFloat = 0.0;
new iInteger = 14;
new aiArrayInteger[10] = {0,1,..};
//etc

//Edit: Für spezielle Tags in Pawn nehm ich auch immer ein Präfix.
new Text:tdTextdraw; // td = TextDraw
new Text3D:t3dLabel;

Damit weiss ich zumindest immer, um was für ein "Objekt" es sich bei der Variable handelt.

Find ich gut,dass Jemand versuchst hier den Coding-Stil zu verbessern.

Alles anzeigen

Habe o.g. Konvention hinzugefügt. Ich füge gerne auch weitere hinzu

Ich denke mal, dass die breite Masse Pascal oder Camel Case benutzt.
Ich bezweifle aber, dass einer die Konvention 4 benutzt.