¿Qué son etiquetas como @param y @return en IntelliJ IDEA?

Acabo de comenzar a utilizar la programación de IntelliJ IDEA para Java y estoy viendo etiquetas (¿se llaman etiquetas?) Como @param y @return. ¿Cuál es el significado de estas etiquetas? ¡IntelliJ realmente se queja si no tengo esas etiquetas en mi código!¿Qué son etiquetas como @param y @return en IntelliJ IDEA?

¿Cuáles son los más importantes para saber y para qué se utilizan?

No pude encontrar nada relevante en la documentación de IntelliJ con respecto a estas etiquetas.

Fuente

2011-10-09 InvalidBrainException

en el código o en los comentarios? – stivlo

En los comentarios en el código, heh. – InvalidBrainException

Las etiquetas y el nivel de advertencia requeridos son una inspección configurable; solo busque "javadoc" en la configuración. –

Sí, se llaman etiquetas. Si ve esas etiquetas en los comentarios, deben documentar los parámetros de su método y el valor de retorno.

Se pueden procesar automáticamente para generar documentación JavaDoc. La documentación generada será similar al Java API Documentation. Ver how to write doc comments for the JavaDoc tool.

Fuente

2011-10-09 13:45:25 stivlo

Gracias. Al aplicar monkey-see monkey-do, deduzco que el formato general para una etiqueta es @tag variable_name_if_any description. – InvalidBrainException

No pestaña, solo espacio en blanco. Además, solo para hacerlo explícito, estas etiquetas no son específicas de IntelliJ. –

¿Estas etiquetas son inútiles en el código creado fuera de un IDE? Es decir, ¿código creado con un editor de texto y compilado en la línea de comando? – InvalidBrainException

¿Qué son etiquetas como @param y @return en IntelliJ IDEA?

Respuesta

Cuestiones relacionadas