Capítulo 46. Tipos de comentarios
Este trabajo se ha traducido utilizando IA. Agradecemos tus opiniones y comentarios: translation-feedback@oreilly.com
Nicolai Parlog
Supongamos que quieres poner algunos comentarios en tu código Java. ¿Utilizas /**, /*, o //? ¿Y dónde los pones exactamente? Más allá de la sintaxis, hay prácticas establecidas que atribuyen semántica a qué se utiliza y dónde.
Comentarios Javadoc para Contratos
Los comentarios Javadoc (los que van encerrados en /** ... */) se utilizan exclusivamente en clases, interfaces, campos y métodos, y se colocan directamente encima de ellos. Aquí tienes un ejemplo de Map::size:
/** * Returns the number of key-value mappings in this map. If the * map contains more than Integer.MAX_VALUE elements, returns * Integer.MAX_VALUE. * * @return the number of key-value mappings in this map */ int size();
El ejemplo demuestra tanto la sintaxis como la semántica: un comentario Javadoc es un contrato. Promete a los usuarios de la API lo que pueden esperar, manteniendo intacta la abstracción central del tipo al no hablar de los detalles de implementación. Al mismo tiempo, obliga a los implementadores a proporcionar el comportamiento especificado.
Java 8 relajó un poco esta rigurosidad, al tiempo que formalizaba diferentes interpretaciones mediante la introducción de las etiquetas (no estandarizadas) @apiNote, @implSpec y @implNote. Los ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access