I guess what I'm asking is, what would be the best way to make sure my code is sufficiently documented and worded right for other people to use?
Come open source, i commenti più importanti di tutti sono il commento del copyright e del contratto di licenza. Piuttosto che un lungo commento all'inizio di ogni file, potresti voler usare uno short e dolce che specifica brevemente il copyright e rimanda il lettore a license.txt nella directory root.
I know you should always comment everything and I'm going to be putting in the @params feature for every method, but are there any other tips in general?
Commenta tutto? No. Commenta quel codice che ha veramente bisogno di commenti. Commento con parsimonia. Come utente potenziale di una porzione di codice, quale delle seguenti due versioni di una definizione di classe preferiresti vedere?
Versione 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; }
...
};
Versione 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; }
...
};
Nella versione A ho documentato tutto, tranne la classe stessa. Una classe in generale non è auto-documentante. I commenti che sono presenti nella versione A sono assolutamente inutili o addirittura peggiori di inutili. Questo è il problema chiave con l'atteggiamento "commenta tutto". Quel piccolo commento laconico sul membro dei dati privati non comunica nulla e i commenti doxygen sul getter hanno un valore negativo. Il getter get_some_name() non ha realmente bisogno di un commento. Quello che fa e ciò che ritorna è chiaramente ovvio dal codice. Che non ci sia un setter: devi dedurlo perché non è lì.
Nella versione B ho documentato ciò che ha bisogno di commenti. Il getter non ha un commento Doxygen, ma ha un commento che dice che non c'è setter.
Rendi contenti i tuoi commenti e fai attenzione che i commenti non vengano mantenuti per riflettere le modifiche al codice.