En unas pocas semanas, mi proyecto estará terminado y quiero comenzar a preparar mi código para que otras personas lo usen.
Voy a publicar todo en GitHub para que la gente pueda modificarlo y, con suerte, mejorarlo.
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?
Sé que siempre debes comentar todo y voy a poner la función @params para cada método, pero ¿hay otros consejos en general?
coding-style
coding-standards
github
Sempus
fuente
fuente
Respuestas:
fuente
La documentación en el archivo fuente siempre es buena, pero debe publicar documentación adicional en un sitio web. Explica su objetivo, cómo funciona, tus planes futuros, intenta hacer una contribución fácil (de lo contrario ... nadie te ayudará) y pon algunos tutoriales.
Intentar trabajar en un proyecto solo con documentación del código fuente siempre es frustrante.
fuente
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.
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:
Versión B:
};
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.
fuente