Code Review: Unterschied zwischen den Versionen

Aus Das Sopra Wiki
← Zum vorherigen VersionsunterschiedZum nächsten Versionsunterschied →
VisuellWikitext
Dietsch (Diskussion | Beiträge)
Bürokraten, sopra, sopra17, sopradozenten, soprapre17, Administratoren
2.877 Bearbeitungen
Keine Bearbeitungszusammenfassung
Dietsch (Diskussion | Beiträge)
Bürokraten, sopra, sopra17, sopradozenten, soprapre17, Administratoren
2.877 Bearbeitungen
Keine Bearbeitungszusammenfassung
Zeile 48: Zeile 48:
Ein gutes Beispiel aus dem Softwarepraktikum ist:
Ein gutes Beispiel aus dem Softwarepraktikum ist:


<pre class="md">94cb043 see #27: Wayfinding improved to support bridges</pre>
<syntaxhighlight lang="markdown">94cb043 see #27: Wayfinding improved to support bridges</syntaxhighlight >
Ein schlechtes Beispiel ist:
Ein schlechtes Beispiel ist:


<pre class="md">959f313 Woololoo</pre>
<syntaxhighlight lang="markdown">959f313 Woololoo</syntaxhighlight>
====Naming (und Coding Conventions)====
====Naming (und Coding Conventions)====


Zeile 58: Zeile 58:
Ein schlechtes Beispiel wäre:
Ein schlechtes Beispiel wäre:


<source lang="csharp">private int mTheIndex;              // nur mIndex wäre besser
<syntaxhighlight lang="csharp">
private int mTheIndex;              // nur mIndex wäre besser
private int mMaxTmpInFl;            // keine Abkürzungen
private int mMaxTmpInFl;            // keine Abkürzungen
private const int FUNNY_JOKE = 42;  // witzige Namen helfen nicht beim Suchen oder verstehen</source>
private const int FUNNY_JOKE = 42;  // witzige Namen helfen nicht beim Suchen oder verstehen
</syntaxhighlight >
Ein gutes Beispiel aus dem Softwarepraktikum ist:
Ein gutes Beispiel aus dem Softwarepraktikum ist:


<source lang="csharp">private GameObject Player;
<syntaxhighlight lang="csharp">
private GameObject Player;
 
protected List<Waypoint> GetRoute(WorldMap map, WayPoint start, WayPoint end)
</syntaxhighlight >


protected List<Waypoint> GetRoute(WorldMap map, WayPoint start, WayPoint end)</source>
===Codestyle und Struktur===
===Codestyle und Struktur===


Zeile 74: Zeile 79:
*Alle Benennungen sind frei von Füllwörtern, Artikeln, dummen Witzen, etc.
*Alle Benennungen sind frei von Füllwörtern, Artikeln, dummen Witzen, etc.
*Benennungen sind einheitlich, d.h. gleiche Dinge heißen immer gleich z.b <code>Get...</code>, <code>Set...</code> usw.
*Benennungen sind einheitlich, d.h. gleiche Dinge heißen immer gleich z.b <code>Get...</code>, <code>Set...</code> usw.
*Klassen haben Namen im Singular z.B.: <code>class SpaceShip</code>
*Klassen haben Namen im Singular z.B.: <syntaxhighlight lang="csharp" inline>class SpaceShip</syntaxhighlight>
*Instanzen von Listen, Mengen, etc. sind im Plural benannt z.B.: <code>private List&lt;SpraceShip&gt; mSpaceShips;</code>
*Instanzen von Listen, Mengen, etc. sind im Plural benannt z.B.: <syntaxhighlight lang="csharp" inline>private List&lt;SpraceShip&gt; mSpaceShips;</syntaxhighlight >
*Methoden sind Verb + Substantiv benannt <code>public GetEnemySpaceShips()</code>
*Methoden sind mit Verb und Substantiv benannt <syntaxhighlight lang="csharp" inline>public GetEnemySpaceShips()</syntaxhighlight >


===Code===
===Code===


Nun soll der Code an sich betrachtet werden. Lese den Code Zeile für Zeile und versuche zu verstehen was der Code macht und ob der Code… - keine offensichtlichen Fehler enthält, - das was er zu machen scheint auf eine sinnvolle Weise macht, und - der Code vereinfacht werden könnte.
Nun soll der Code an sich betrachtet werden. Lesen Sie den Code Zeile für Zeile und versuchen Sie zu verstehen, was der Code macht und ob der Code… - keine offensichtlichen Fehler enthält, - das was er zu machen scheint auf eine sinnvolle Weise macht, und - der Code vereinfacht werden könnte.


====Keine offensichtlichen Fehler====
====Keine offensichtlichen Fehler====
Abgerufen von „https://sopranium.de/Code_Review“