Coding Conventions: Unterschied zwischen den Versionen

Aus Das Sopra Wiki
← Zum vorherigen Versionsunterschied
VisuellWikitext
Hofmann (Diskussion | Beiträge)
sopra
83 Bearbeitungen
Keine Bearbeitungszusammenfassung
Dietsch (Diskussion | Beiträge)
Bürokraten, sopra, sopra17, sopradozenten, soprapre17, Administratoren
2.806 Bearbeitungen
 
(63 dazwischenliegende Versionen von 5 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
{{Stub}}
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.
[[Kategorie:Begriffe]]
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. Zusätzlich beinhalten [[Coding Conventions]] meistens auch Vorgaben für die richtige [[Dokumentation]] des Codes.
 
===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.
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:Sopra-Resharper.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]]).
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 genauen Einzelheiten der Coding Conventions finden Sie bitte selbst heraus. Hier soll nur eine kurze Liste der wichtigsten Dinge benannt werden:
In diesem Abschnitt wird beschrieben nach welchen Regeln Klassen, Typen, Variabeln usw.
benannt werden müssen.


==== Naming Conventions ====
== Namenskonventionen ==


===== Typen, Klassen, Methoden & Konstanten =====
Die folgenden Namenskonventionen sind einzuhalten:


Für die Bennenung von [[Datentyp|Type]], [[Klasse|Klassen]], [[Methode|Methoden]] und Konstanten
* Typen und Namespaces: <tt>UpperCamelCase</tt>
benutzen wird die Namenkonventionen aus Pascal. Diese sehen vor, dass die Anfangsbuchstaben groß geschrieben werden und der Rest klein.
* Interfaces: <tt>IUpperCamelCase</tt>
* Typ Parameter: <tt>TUpperCamelCase</tt>
* Methoden, Properties und Events: <tt>UpperCamelCase</tt>
* Lokale Variablen: <tt>lowerCamelCase</tt>
* Lokale Konstanten: <tt>lowerCamelCase</tt>
* Parameter: <tt>lowerCamelCase</tt>
* 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 Readonly Felder (nicht private): <tt>sUpperCamelCase</tt>
* Statische Readonly Felder (private): <tt>sUpperCamelCase</tt>
* Enum Member: <tt>UpperCamelCase</tt>
* Alles andere: <tt>UpperCamelCase</tt>


Dies gilt auch für zusammengesetzte Namen wie z.B."DefaultSize".
== Klammerung ==


* Geschweifte Klammern stehen immer alleine in einer Zeile (einzige Ausnahme sind einzeilige [[Property|Properties]]). Beispiel:
<source lang="csharp">
<source lang="csharp">
public class SomeClass
class Class1
{  
{
   const int DefaultSize = 100;  
   private int mVariable;
  public void SomeMethod()
  {
    // do something
  }
}
</source>


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


Bei Variabel wird die Namenkonventionen verwendet die in Camel üblich ist. Diese unterscheiden sich geringfügig von den Konvention aus Pascal.
  // Single-line Property
 
  public int Variable
Der einzige unterschied ist, dass der Name am Anfang klein geschrieben wird.
  {
 
      get { return mVariable; }
<source lang="csharp">
      set { mVariable = value; }
void MyMethod(int someNumber)
   }
{
   int number;
}
}
</source>
</source>


===== Interfaces =====
* Runde Klammern (zum Beispiel bei der Verwendung von Parametern) haben keine Leerzeichen nach dem Öffnen der Klammer:
 
Bei Interfaces wird dem Klassen- und Dateinamen ein "I" angehängt.
 
<source lang="csharp">
<source lang="csharp">
interface INewInterface
void Method(string s)
{  
{
  //
}
}
</source>
</source>


===== Private  Klassenvariabeln =====
== Sprache im Code ==


Einer Private Klassenvariablen wird ein "_" vorangestellt, die Variable wird dann nach den Camel Konventionen benannt.
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.


<source lang="csharp">
[[Kategorie:Begriffe]]
public class SomeClass3
[[Kategorie:Entwurf]]
{
[[Kategorie:MS01]] [[Kategorie:Code-Beispiele]]
  private int _number;
}
</source>
 
==== Naming Style ====
 
===== Methoden =====
 
Regeln für das Sinnvolle benennen von Methoden:
 
*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()'''.
 
===== 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 Hungarian Notation]
**Verwende '''keine''' Abkürzungen z.B. num statt number.
 
===== Generische Typen =====
 
Verwende für den
 
=== Coding Style ===
 
==== Kommentare ====
 
===== Single Line Comments =====
 
===== Block Comments =====
 
===== Documentation Comments =====
 
==== White Space ==== [[Kategorie:Code-Beispiele]]

Aktuelle Version vom 16. November 2020, 19: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. Zusätzlich beinhalten Coding Conventions meistens auch Vorgaben für die richtige Dokumentation des Codes.

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:Sopra-Resharper.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.

Abgerufen von „https://staging.sopranium.de/index.php?title=Coding_Conventions&oldid=9994“