¿Qué método de comentario es el más ampliamente aceptado o realmente importa?Java Commenting Conventions
He estado usando
/**
* (Method description)
* @param
* @return
* etc
*/
Sin embargo he leído de:
Precondition:
Postcondition:
¿Hay una manera más 'profesional' de comentar?
Éstos son Java convenciones de codificación para los comentarios recomendados por Oracle:
Estas son las recomendaciones de Google para su plataforma Android:
Para obtener información más detallada sobre el estilo y las convenciones de Javadoc, ver aquí:
El vínculo con las recomendaciones de Google parece haber desaparecido o restringido. Tal vez este es el reemplazo? http://source.android.com/source/code-style.html#use-javadoc-standard-comments –
Creo que las convenciones de Javadoc son las mejores. ¿Alguien tiene las recomendaciones de Oracle pdf o una nueva dirección? –
El estilo de comentario en su primer ejemplo no es sólo una convención, que es un estándar para un instrumento de documentación llamado Javadoc. Si sigues ese estilo de comentarios de Javadoc, podrás generar fácilmente la documentación con formato html para todo tu código fuente.
Simplemente seguiría el estándar definido por Sun (Oracle) para escribir Javadoc. Javadoc es referido por todos los desarrolladores por unanimidad :). Para obtener más información, haga clic en here
También le pediría que haga lo siguiente search on Stackoverflow para un montón de preguntas y respuestas al comentar.
This enlace es muy útil y he estado utilizando durante mucho tiempo y me ha ayudado mucho. Esto crea un código muy bueno y documentado con la máxima legibilidad.
En primer lugar, tener código legible y comentarios legibles son dos cosas totalmente diferentes.
código legible es el código de los usos buena variables, métodos, nombres de clases, etc.
comentarios legibles son más una cuestión de gusto personal. A algunas personas les gustan los comentarios para seguir las reglas gramaticales que se usarían para escribir un libro, mientras que a otros no les importaría lo gramatical. Usted puede ir a través de este enlace:
http://www.oracle.com/technetwork/java/codeconventions-141999.html#385
De código legible y comentarios, puede crear documentos con la ayuda de doxygen.
posible duplicado de [Convenios Comentando] (http://stackoverflow.com/questions/999431/commenting-conventions) – krock