Supongo que lo que pregunto es, ¿cuál sería la mejor manera de asegurarme de que mi código esté suficientemente documentado y redactado correctamente para que otras personas lo usen?
Como código abierto, los comentarios más importantes de todos son los comentarios sobre derechos de autor y acuerdos de licencia. En lugar de un gran comentario largo al comienzo de cada archivo, es posible que desee utilizar uno breve y dulce que especifique brevemente los derechos de autor y remita al lector a license.txt en el directorio raíz.
Sé que siempre debes comentar todo y voy a poner la función @params para cada método, pero ¿hay otros consejos en general?
Comenta todo? No. Comenta ese código que realmente necesita comentarios. Comenta con moderación. Como usuario potencial de un fragmento de código, ¿cuál de las siguientes dos versiones de una definición de clase preferiría ver?
Versión 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; }
...
};
Versión 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; }
...
};
En la versión A, he documentado todo, excepto la clase misma. Una clase en general no es autodocumentada. Los comentarios que están presentes en la versión A son absolutamente inútiles, o incluso peores que inútiles. Ese es el problema clave con la actitud de "comentar todo". Ese pequeño comentario breve sobre el miembro de datos privados no comunica nada, y los comentarios de doxygen sobre el captador tienen un valor negativo. El captador get_some_name()realmente no necesita un comentario. Lo que hace y lo que devuelve es evidentemente obvio en el código. Que no hay setter, tienes que inferir eso porque no está allí.
En la versión B, he documentado lo que necesita comentarios. El getter no tiene un comentario de doxygen, pero tiene un comentario que menciona que no hay setter.
Haga que sus comentarios cuenten y tenga en cuenta que los comentarios a menudo no se mantienen para reflejar los cambios en el código.