Dokumentation

Aus Das Sopra Wiki
Wechseln zu: Navigation, Suche

Dokumentation

Warum kommentieren?

Kommentieren macht den Programmcode für andere verständlicher. Jeder Entwickler wird dankbar über hilfreiche Kommentare sein, die ein persönliches Nachfragen und somit viel Zeit ersparen. Selbst wenn man nur alleine an einem Projekt arbeitet, sollte man sich fragen, ob das auch für die Zukunft gilt.

Beim Schreiben einer Bibliothek muss diese zwingend dokumentiert werden, da Benutzer der Bibliothek deren Quellcode meistens nicht lesen möchten. Auch in diesem Fall helfen Kommentare, da aus ihnen automatisiert eine Dokumentation erstellt werden kann.

Gutes Kommentieren kann außerdem das Design des Programms verbessern.[1] Wenn man nach dem Single Responsibility Principle (SRP) vorgeht, so kann man den Verantwortungsbereich jeder Klasse in einem Kommentar ausdrücken. Auf diese Weise kann man stetig kontrollieren, ob die Klasse in ihrem Verantwortungsbereich operiert und das Implementieren von Aufgaben vermeiden, die nicht zu dieser Klasse gehören.


Kommentare in C# und Doxygen

C# und Visual Studio bieten verschiedene Möglichkeiten an, Kommentare zu verfassen. Neben den einzeiligen Kommentaren, die nur für kurze Anmerkungen verwendet werden sollten, gibt es noch mehrzeilige Kommentare und XML Kommentare, mit denen sich der Quellcode gut dokumentieren lässt.

Einzeilige Kommentare

Einzeilige Kommentare beginnen mit zwei Slashes und enden automatisch am Ende der Zeile:

//Dies ist ein einzeiliger Kommentar. Er endet automatisch am Ende der
//Zeile, so dass // in jeder Zeile wiederholt werden muss.

int i = 0; // Einzeilige Kommentare können auch in der Mitte einer Zeile beginnen

Mehrzeilige Kommentare

Ein Stern nach einem Slash (/*) leitet einen Kommentarblock ein. Der Kommentar endet erst, wenn das das entsprechende Token zum beenden des abgegrenzten Kommentars gefunden wurde (*/).

/* Dies ist ein mehrzeiliger 
Kommentar. Ich brauche nicht 
jede Zeile wieder neu als
Kommentar markieren. */

XML Kommentare

Mit XML Kommentaren können Klassen, Methoden, Eigenschaften, etc. zusätzliche Meta-Informationen mitgegeben werden, um die Dokumentation des Codes zu erleichtern. Gibt man in Visual Studio vor einer bereits deklarierten Prozedur drei Slashes (/) ein, so werden anhand der Signatur der Funktion automatisch die notwendigen XML Tags erstellt.

/// <summary>
/// Calculates length of the hypotenuse in a right-angled triangle. 
/// (Pythagorean theorem)
/// </summary>
/// <param name="a">length of first leg</param>
/// <param name="b">length of second leg</param>
/// <returns>length of hypotenuse</returns>
public double GetHypotenuse(double a, double b)
{
    return Math.Sqrt(Math.Pow(a, 2) + Math.Pow(b, 2));
}

Mit XML Kommentaren lässt sich zum Beispiel auch angeben, ob und wann Exceptions auftreten können oder es lassen sich Querverweise zu anderen Stellen im Code definieren. [2]

Praktisch an XML Kommentaren ist, dass diese automatisch in einem Tooltip erscheinen, wenn die entsprechend dokumentierte Klasse, Methode, etc. bei der Codeeingabe verwendet wird.

Aufgabenliste-Kommentare

Visual Studio kann in Kommentaren nach bestimmten Token suchen und diese dann in der Aufgabenliste gesammelt anzeigen. So können zum Beispiel Codestellen markiert werden, die noch einer Bearbeitung bedürfen. Vordefinierte Token sind TODO, HACK und UNDONE. Ein Token muss immer direkt hinter den Zeichen stehen, die den Kommentar einleiten.

// TODO Diese Zeile erscheint in der Aufgabenliste

/* HACK Auch dieser mehrzeilige Kommentar
erscheint in der Aufgabenliste */

Es können auch eigene Token erstellt werden.[3]

Doxygen Befehle

Wird ein Programm wie Doxygen verwendet, um aus dem Source Code automatisiert eine Dokumentation zu generieren, so können in den Kommentaren noch zusätzlich Special Commands[4] verwendet werden. Mit ihnen lassen sich zum Beispiel der Text formatieren oder man kann bestimmte Meta-Informationen zum Code mitgeben.


Wie kommentieren?

Innerhalb von Methoden

Nach den Clean Code Prinzip sollte ein Programm sich selbst beschreiben und mit möglichst wenigen Kommentaren auskommen[5]:

Statt:

int length = 210;  // Länge in mm

Besser:

int lengthInMm = 210;

Statt:

public Vector3D Position() {
    // Calculates new Position
}

Besser:

public Vector3D CalculateNewPosition() {
    ...
}

Klassen bzw. außerhalb von Methoden

Klassen, Methoden, Prozeduren, Funktionen, etc. sollten mit XML Kommentaren versehen werden. Diese werden verwendet um die automatisierte Dokumentation zu bauen. Außerdem werden XML Kommentare dazu verwendet, bei der Codeeingabe Hinweise in einer Tooltip Box anzuzeigen, so dass das arbeiten mit dokumentierten Funktionen deutlich leichter fällt.

Wie man NICHT kommentieren sollte

Manchmal ist es einfach leichter zu sagen, wie man es eben nicht machen sollte[6]:

Unterschätze die Zielgruppe nicht

Wer auch immer in den Code reinschauen wird, es wird sicherlich auch ein Entwickler (aus deinem Team?) sein. Solche Kommentare sind völlig unnötig und gehören raus:

ACHTUNG NEGATIVBEISPIEL!

//Initialisiere i mit 20
int i = 20;

Übertreibe es nicht

Wenn man aufgrund lauter Kommentare den Code selbst plötzlich suchen muss, dann wurde inzwischen bei weitem viel zu viel kommentiert. Innerhalb von Prozeduren sollten nur dann Kommentare verwendet werden, wenn es aus dem Code selbst nicht ersichtlich ist, was er tut (Clean Code Ansatz).

Trenne dich von altem Code

Lösche nicht mehr gebrauchten Code, anstatt ihn auszukommentieren. Ansonsten sammeln sich nach und nach im Quellcode immer mehr Codeleichen an, die völlig unnötig sind.

Du sollst nicht Fluchen

Selbst wenn dich gerade ein Stück Code in Rage versetzt, solltest du dich beim Schreiben eines Kommentars zurückhalten. Es ist gesünder für die Zusammenarbeit im Team und kann dich im Berufsleben im schlimmsten Fall den Job kosten.


Wann kommentieren?

Kommentieren ist schön und gut, aber wann genau soll nun kommentiert werden? Es gibt mehrere Ansätze, Kommentare zu verfassen, die auch von dem jeweiligen Programmierstil abhängen.

Bei einem geplanten Vorgehen überlegt man sich im Voraus, was der Code genau leisten soll. Dann spezifiziert man die Parameter und die Rückgabe und verfasst noch vor dem Implementieren einen Kommentar der beschreibt, was der Code leisten wird. Vorteil dieses Ansatzes ist, dass auf diese Weise Funktionen und Klassen markiert werden können, die man (oder ein anderer Entwickler) erst später implementieren wird. Solche Codestellen sollten unbedingt mit einem Aufgabenliste-Kommentar markiert werden.

Geht man etwas ungeplanter vor, so kann es passieren, dass man eine Funktion implementiert, diese aber kurze Zeit später erweitert, überarbeitet oder gar durch eine neue ersetzt. Jetzt jederzeit Kommentare zu schreiben, die man nur wenige Minuten später wieder wegschmeißt ist unnötiger Aufwand. Aus diesem Grund schiebt man das Kommentieren und somit das Dokumentieren der Funktion vor sich her. Dennoch sollte die finale Version der Funktion letztendlich kommentiert sein.

Ein guter Richtwert ist: Wenn man ins Git committet, dann sollte alles kommentiert sein! (Committen sollte man sowieso nur sauberen Code.)

Referenzen

  1. http://dkrukovsky.blogspot.de/2005/07/how-to-write-comments.html Make The Software Shine - How to Write Comments
  2. http://msdn.microsoft.com/en-us/library/5ast78ax.aspx Microsoft MSDN - Recommended Tags for Documentation Comments (C# Programming Guide)
  3. http://msdn.microsoft.com/en-us/library/zce12xx2(VS.80).aspx Mircrosoft msdn Library - How to: Create Task List Comments
  4. http://www.stack.nl/~dimitri/doxygen/commands.html Doxygen Manual - Special Commands
  5. http://www.clean-code-developer.de/Source-Code-Konventionen.ashx Clean Code Developer - Source Code Konventionen
  6. http://allthingsoracle.com/how-to-make-comments-the-most-important-code-you-write/ How to make comments the most important 'code' you write