Convenciones de comentar de Java
java jframe center window (5)
Aquí están las convenciones de codificación de Java para comentarios recomendados por Oracle:
Aquí están las recomendaciones de Google para su plataforma Android:
Para obtener información más detallada sobre el estilo y las convenciones de Javadoc, consulte aquí:
¿Qué método de comentar es el más aceptado o realmente importa?
he estado usando
/**
* (Method description)
* @param
* @return
* etc
*/
Sin embargo he leído de:
Precondition:
Postcondition:
¿Hay alguna forma más profesional de comentar?
El estilo de comentario en su primer ejemplo no es solo una convención, es un estándar para una herramienta de documentación llamada Javadoc . Si sigue el estilo de comentarios de Javadoc, podrá generar fácilmente la documentación en formato html para todo su código fuente.
En primer lugar, todo código legible y comentarios legibles son dos cosas que son totalmente diferentes.
El código legible es el código que utiliza una buena variable, método, nombres de clase, etc.
Los comentarios legibles son más una cuestión de gusto personal. A algunas personas les gusta que los comentarios sigan las reglas gramaticales que se usarían para escribir un libro, mientras que a otros no les importan las cosas gramaticales. Puedes ir a través de este enlace:
http://www.oracle.com/technetwork/java/codeconventions-141999.html#385
Desde el código y los comentarios legibles, puede crear documentación con la ayuda de doxygen.
Simplemente seguiría el estándar definido por Sun (Oracle) para escribir Javadoc. Javadoc es referido por todos los desarrolladores por unanimidad :). Para más información haz click aquí.
También le pediría que haga una búsqueda posterior en para muchas preguntas y respuestas sobre comentarios.
https://.com/search?q=commenting
This enlace es muy útil y lo he estado usando durante mucho tiempo y me ha ayudado mucho. Esto crea un código muy bueno y documentado con la máxima legibilidad.