Coding Conventions: Unterschied zwischen den Versionen

Aktuelle Version vom 5. August 2021, 13:09 Uhr

Mit Coding Conventions sind ein mehr oder weniger fester Satz von Regeln gemeint, an die sich alle an einem Projekt teilnehmenden Programmierer halten sollten um den Quellcode leichter les- und wartbar zu machen. 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.

Die Coding Conventions, die Sie im SoPra verwenden, werden durch das Visual Studio Plugin Resharper (im Downloadbereich herunterladbar) durchgesetzt. Jeder Teilnehmer des Softwarepraktikums hat sich an diese Coding Conventions zu halten. Die Coding Conventions für ReSharper sind in der Datei Datei:UserSettings.zip enthalten. Eine Installationsanleitung für die benutzerspezifischen Einstellungen befindet sich hier. Es ist wichtig, dass Ihr Programm keine Warnungen und Fehlermeldungen von ReSharper enthält (vgl. Technische Anfoderungen).

Die genauen Einzelheiten der Coding Conventions finden Sie bitte selbst heraus. Hier soll nur eine kurze Liste der wichtigsten Dinge benannt werden:

Namenskonventionen

Die folgenden Namenskonventionen sind einzuhalten:

Typen und Namespaces: UpperCamelCase
Interfaces: IUpperCamelCase
Typ Parameter: TUpperCamelCase
Methoden, Properties und Events: UpperCamelCase
Lokale Variablen: lowerCamelCase
Lokale Konstanten: lowerCamelCase
Parameter: lowerCamelCase
Felder (nicht private): mUpperCamelCase
Instanzvariablen (private): mUpperCamelCase
Statische Felder (nicht private): sUpperCamelCase
Konstante Felder (nicht private): UpperCamelCase
Konstante Felder (private): UpperCamelCase
Statische Readonly Felder (nicht private): sUpperCamelCase
Statische Readonly Felder (private): sUpperCamelCase
Enum Member: UpperCamelCase
Alles andere: UpperCamelCase

Klammerung

Geschweifte Klammern stehen immer alleine in einer Zeile (einzige Ausnahme sind einzeilige Properties). Beispiel:

class Class1
{
   private int mVariable;

   // Braces in methods
   int Main()
   {
      int a = 3;
      if (a < 3)
      {
         return 1;
      }
      else
      {
         return 0;
      }  
   }

   // Single-line Property
   public int Variable
   {
      get { return mVariable; }
      set { mVariable = value; }
   }
}

Runde Klammern (zum Beispiel bei der Verwendung von Parametern) haben keine Leerzeichen nach dem Öffnen der Klammer:

void Method(string s)
{
}

Sprache im Code

Die vornehmliche Sprache für alles, was mit dem Quelltext zu tun hat, ist Englisch. Das bedeutet, dass alle Variablen-, Methoden- und Klassenvariablen englisch benannt werden, um die Verständlichkeit des Codes zu erhöhen. Auch für Kommentare wird Englisch empfohlen, ist hier jedoch nicht ganz so wichtig.

@@ Zeile 1: / Zeile 1: @@
 {{Stub}}
-[[Kategorie:Begriffe]]
-===Allgemein===
 Mit '''Coding Conventions''' sind ein mehr oder weniger fester Satz von Regeln gemeint, an die sich alle an einem Projekt teilnehmenden Programmierer halten sollten um den Quellcode leichter les- und wartbar zu machen.
 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 & Style Conventions  ===
+Die Coding Conventions, die Sie im SoPra verwenden, werden durch das Visual Studio Plugin Resharper (im [[Downloads|Downloadbereich]] herunterladbar) durchgesetzt. Jeder Teilnehmer des Softwarepraktikums hat sich an diese Coding Conventions zu halten. Die Coding Conventions für ReSharper sind in der Datei [[Datei:UserSettings.zip]] enthalten. Eine Installationsanleitung für die benutzerspezifischen Einstellungen befindet sich [[Downloads#ReSharper|hier]]. Es ist wichtig, dass Ihr Programm keine Warnungen und Fehlermeldungen von ReSharper enthält (vgl. [[Anforderungen#Technische Anforderungen|Technische Anfoderungen]]).
-In diesem Abschnitt wird beschrieben nach welchen Regeln Klassen, Typen, Variabeln usw.
-benannt werden müssen.
-==== Naming Conventions ====
-===== Typen, Klassen, Methoden & Konstanten =====
-Für die Bennenung von [[Datentyp|Type]], [[Klasse|Klassen]], [[Methode|Methoden]] und Konstanten
-benutzen wird die Namenkonventionen aus Pascal. Diese sehen vor, dass die Anfangsbuchstaben groß geschrieben werden und der Rest klein.
-Dies gilt auch für zusammengesetzte Namen wie z.B."DefaultSize".
+Die genauen Einzelheiten der Coding Conventions finden Sie bitte selbst heraus. Hier soll nur eine kurze Liste der wichtigsten Dinge benannt werden:
-<source lang="csharp">
+== Namenskonventionen ==
-public class SomeClass
-{
-   const int DefaultSize = 100;
-   public void SomeMethod()
-   {
-     // do something
-   }
-}
-</source>
-===== Lokale Variablen & Methoden Parameter =====
+Die folgenden Namenskonventionen sind einzuhalten:
-Bei Variabel wird die Namenkonventionen verwendet die in Camel üblich ist. Diese unterscheiden sich geringfügig von den Konvention aus Pascal.
+* [[Datentyp|Typen]] und [[Namensraum|Namespaces]]: <tt>UpperCamelCase</tt>
+* [[Interface]]s: <tt>IUpperCamelCase</tt>
+* [[Generic|Typ Parameter]]: <tt>TUpperCamelCase</tt>
+* [[Methode]]n, [[Property|Properties]] und Events: <tt>UpperCamelCase</tt>
+* Lokale [[Variable]]n: <tt>lowerCamelCase</tt>
+* Lokale [[Variable#Konstanten|Konstanten]]: <tt>lowerCamelCase</tt>
+* [[Methode#Parameter|Parameter]]: <tt>lowerCamelCase</tt>
+* [[Klasse|Felder]] (nicht private): <tt>mUpperCamelCase</tt>
+* Instanzvariablen (private): <tt>mUpperCamelCase</tt>
+* Statische Felder (nicht private): <tt>sUpperCamelCase</tt>
+* Konstante Felder (nicht private): <tt>UpperCamelCase</tt>
+* Konstante Felder (private): <tt>UpperCamelCase</tt>
+* Statische [[Modifizierer|Readonly]] Felder (nicht private): <tt>sUpperCamelCase</tt>
+* Statische Readonly Felder (private): <tt>sUpperCamelCase</tt>
+* [[Enum]] Member: <tt>UpperCamelCase</tt>
+* Alles andere: <tt>UpperCamelCase</tt>
-Der einzige unterschied ist, dass der Name am Anfang klein geschrieben wird.
+== Klammerung ==
+* Geschweifte Klammern stehen immer alleine in einer Zeile (einzige Ausnahme sind einzeilige [[Property|Properties]]). Beispiel:
 <source lang="csharp">
-void MyMethod(int someNumber)
+class Class1
 {
-    int number;
+    private int mVariable;
-}
-</source>
-===== Interfaces =====
-Bei Interfaces wird dem Klassen- und Dateinamen ein "I" angehängt.
+   // Braces in methods
+   int Main()
+   {
+      int a = 3;
+      if (a < 3)
+      {
+         return 1;
+      }
+      else
+      {
+         return 0;
+      }
+   }
-<source lang="csharp">
+   // Single-line Property
-interface INewInterface
+   public int Variable
-{
+   {
-    //
+      get { return mVariable; }
+      set { mVariable = value; }
+    }
 }
 </source>
-===== Private  Klassenvariabeln =====
+* Runde Klammern (zum Beispiel bei der Verwendung von Parametern) haben keine Leerzeichen nach dem Öffnen der Klammer:
-Einer Private Klassenvariablen wird ein "_" vorangestellt, die Variable wird dann nach den Camel Konventionen benannt.
 <source lang="csharp">
-public class SomeClass3
+void Method(string s)
 {
-   private int _number;
 }
 </source>
-==== Naming Style ====
+== Sprache im Code ==
-===== Methoden =====
+Die vornehmliche Sprache für alles, was mit dem Quelltext zu tun hat, ist Englisch. Das bedeutet, dass alle Variablen-, Methoden- und Klassenvariablen englisch benannt werden, um die Verständlichkeit des Codes zu erhöhen. Auch für Kommentare wird Englisch empfohlen, ist hier jedoch nicht ganz so wichtig.
-Regeln für das Sinnvolle benennen von Methoden:
+[[Kategorie:Begriffe]]
+[[Kategorie:Entwurf]]
-*Benutze Paare bestehend aus einem Verb und dem Objektname z.B. '''ShowDialog()'''.
+[[Kategorie:MS01]] [[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]]

Coding Conventions: Unterschied zwischen den Versionen

Aktuelle Version vom 5. August 2021, 13:09 Uhr

Namenskonventionen

Klammerung

Sprache im Code

Navigationsmenü