Ich denke, was ich frage, ist, wie ich am besten sicherstellen kann, dass mein Code ausreichend dokumentiert und richtig formuliert ist, damit andere ihn verwenden können.
Als Open Source sind die wichtigsten Kommentare der Kommentar zu Urheberrechten und Lizenzvereinbarungen. Anstelle eines großen langen Kommentars am Anfang jeder Datei möchten Sie möglicherweise einen kurzen und süßen Kommentar verwenden, der das Urheberrecht kurz angibt und den Leser auf die Datei license.txt im Stammverzeichnis verweist.
Ich weiß, dass Sie immer alles kommentieren sollten und ich werde die @ params-Funktion für jede Methode einfügen, aber gibt es generell noch andere Tipps?
Alles kommentieren? Kommentieren Sie den Code, der wirklich kommentiert werden muss. Kommentar sparsam. Welche der folgenden beiden Versionen einer Klassendefinition möchten Sie als potenzieller Benutzer eines Codeabschnitts lieber sehen?
Version A:
class Foo {
private:
SomeType some_name; //!< State machine state
public:
...
/**
* Get the some_name data member.
* @return Value of the some_name data member.
*/
SomeType get_some_name () const { return some_name; }
...
};
Version B:
/**
* A big long comment that describes the class. This class header comment is very
* important, but also is the most overlooked. The class is not self-documenting.
* Why is that class here? Your comments inside the class will say what individual parts
* do, but not what the class as a whole does. For a class, the whole is, or should be,
* greater than the parts. Do not forget to write this very important comment.
*/
class Foo {
private:
/**
* A big long comment that describes the variable. Just because the variable is
* private doesn't mean you don't have to describe it. You might have getters and
* setters for the variable, for example.
*/
SomeType some_name;
public:
...
// Getters and setters
...
// Getter for some_name. Note that there is no setter.
SomeType get_some_name () const { return some_name; }
...
};
In Version A habe ich alles dokumentiert - außer der Klasse selbst. Eine Klasse ist im Allgemeinen nicht selbstdokumentierend. Die Kommentare in Version A sind absolut nutzlos oder sogar schlimmer als nutzlos. Das ist das Hauptproblem bei der Einstellung "Alles kommentieren". Dieser kleine knappe Kommentar zum privaten Datenelement kommuniziert nichts, und die Sauerstoffkommentare zum Getter haben einen negativen Wert. Der Getter get_some_name()braucht eigentlich keinen Kommentar. Was es tut und was es zurückgibt, ist aus dem Code offensichtlich ersichtlich. Dass es keinen Setter gibt - darauf muss man schließen, weil er nicht da ist.
In Version B habe ich dokumentiert, was kommentiert werden muss. Der Getter hat keinen Sauerstoffkommentar, aber einen Kommentar, der besagt, dass es keinen Setter gibt.
Stellen Sie sicher, dass Ihre Kommentare zählen, und achten Sie darauf, dass Kommentare häufig nicht beibehalten werden, um Änderungen am Code widerzuspiegeln.