Diferencias

Muestra las diferencias entre dos versiones de la página.

--- bloque3:javadoc [29/05/2019 20:39] – [Documentar métodos] Fernando Valdeón
+++ bloque3:javadoc [16/09/2024 20:53] (actual) – editor externo 127.0.0.1
@@ Línea 35: / Línea 35: @@
 Si nos fijamos en la API de Java de alguna clase, p.e [[https://docs.oracle.com/javase/8/docs/api/java/lang/String.html|String ]] podemos tener una idea de cómo y qué se debe documentar.
-Aquí vemos la documentación del método charAt() de la clase //String//:
+Aquí vemos la documentación del método //charAt()// de la clase //String//:
 <code java>
@@ Línea 73: / Línea 73: @@
 {{ :bloque3:javadoc-eclipse.png?800 |}}
+Como se ha indicado anteriormente, en la documentación de un método se debe indicar:
+  * Descripción de la funcionalidad del método
+  * Descripción de la finalidad de los parámetros
+  * Descripción de la finalidad del valor de retorno
+  * Excepciones, si es que lanza alguna
 ==== Tags o Etiquetas ====
   * **Documentación de clases e interfaces**