Cómo manejar los comentarios de Javadoc

En los programas Java, los comentarios de Javadoc son muy importantes, pero a menudo se ignoran. Simplemente mire el código del proyecto y lo sabrá. Si está programando en parejas, su compañero dirá: "Hombre, aquí faltan comentarios, ¡los comentarios de Javadoc para esta función son incorrectos!". Hay muchos desarrolladores en el proyecto y sus niveles y hábitos varían. comentarios javadoc en el programa, esto no se puede cambiar y debe estandarizarse. ¿Cómo pueden todos desarrollar este hábito? A continuación le presentaremos cómo utilizar IntelliJ IDEA.

El soporte predeterminado de IDEA para Javadoc es muy bueno, pero aquí tenemos que introducir un complemento, que es el complemento de sincronización JavaDoc. La combinación de los dos será perfecta: el complemento de sincronización JavaDoc se lo indicará. para agregar comentarios de javadoc y comentarios sincrónicos, y la propia IDEA verificará la sintaxis de javadoc, lo que facilita mucho nuestro trabajo.

Primero, abra el administrador de complementos para descargar e instalar el complemento de sincronización JavaDoc, reinicie IDEA y seleccione la opción "Error" en el panel de configuración, y luego seleccione el campo de filtro de texto en " Cuadro de diálogo "Error". Ingrese javadoc en el campo de filtro de texto del cuadro de diálogo. Aparecerán las opciones de configuración relacionadas con javadoc. Expliquemos estas configuraciones:

La declaración tiene un problema de javadoc: esta configuración se usa principalmente para verificar errores de sintaxis de javadoc, como. como comentarios javadoc innecesarios, etiquetas requeridas faltantes, etc. Declarar problemas de javadoc: esta configuración se utiliza principalmente para verificar errores de sintaxis de javadoc, como comentarios de javadoc innecesarios, etiquetas requeridas faltantes, etc. Hay muchas configuraciones de parámetros para esta configuración, puede consultarlas;

Javadoc inconsistente detecta principalmente conflictos de anotaciones de javadoc, como javadoc inconsistente de interfaces y clases de implementación

Javadoc de clase faltante; delcaration, etc. Se recomienda agregar Note. .

Severidad El pequeño botón en el extremo derecho puede configurar el efecto de visualización del nivel de error.

Con estas configuraciones, creo que no olvidará agregar comentarios de javadoc, porque IDEA se lo indicará en tiempo real (resaltado, fondo, etc.). Esta es la función de revisión de código de IDEA. . IDEA también proporciona la función de agregar y corregir rápidamente anotaciones. La adición, sincronización y corrección de errores de anotaciones se pueden completar con una sola operación del teclado.

Resumen: A través de la configuración anterior, creo que todos desarrollarán el buen hábito de escribir Javadoc en un formato unificado. Por ejemplo, bajo la administración de un sistema de control de versiones, las anotaciones de clases Java requieren etiquetas @author y @version, lo cual es muy útil para que todos agreguen código a la administración. Al mismo tiempo, IDEA también le permite configurar diferentes efectos de visualización para diferentes niveles de error, de modo que pueda identificar varios problemas en el documento para facilitar su gestión.