Coding Conventions: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Keine Bearbeitungszusammenfassung |
Keine Bearbeitungszusammenfassung |
||
| Zeile 6: | Zeile 6: | ||
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]]). | 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]]). | ||
Die genauen | Die genauen Einzelheiten der Coding Conventions finden Sie bitte selbst heraus. Hier soll nur eine kurze Liste der wichtigsten Dinge benannt werden: | ||
== Namenskonventionen == | == Namenskonventionen == | ||
| Zeile 37: | Zeile 37: | ||
private int mVariable; | private int mVariable; | ||
// Braces in methods | |||
int Main() | int Main() | ||
{ | { | ||
| Zeile 50: | Zeile 51: | ||
} | } | ||
// Single-line Property | |||
public int Variable | public int Variable | ||
{ | { | ||
| Zeile 64: | Zeile 66: | ||
} | } | ||
</source> | </source> | ||
== 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 in englische Namen haben sollen, um die Verständlichkeit des Codes zu erhöhen. Auch für Kommentare wird Englisch empfohlen, ist hier jedoch nicht ganz so wichtig. | |||
[[Kategorie:Begriffe]] | [[Kategorie:Begriffe]] | ||
[[Kategorie:Entwurf]] | [[Kategorie:Entwurf]] | ||
[[Kategorie:MS01]] [[Kategorie:Code-Beispiele]] | [[Kategorie:MS01]] [[Kategorie:Code-Beispiele]] | ||
