Es muy importante que los desarrolladores de programas adjunten comentarios al código. Con el desarrollo de la tecnología, se debe requerir que los programadores escriban comentarios de código durante el desarrollo del proyecto, que conduce a la redacción y uso posteriores del código.
Requisitos básicos:
1. Formulario de comentarios unificados
A lo largo de la aplicación, use estilos con puntuación y estructura consistentes para construir anotaciones. Si encuentra que sus especificaciones de anotación son diferentes de este documento en otros proyectos, escriba el código de acuerdo con esta especificación y no intente introducir nuevas especificaciones en el sistema de especificaciones establecido.
2. El contenido de comentarios es preciso y conciso
El contenido debe ser simple, claro y preciso, y el significado debe evitarse con la ambigüedad de los comentarios. Los comentarios incorrectos no solo son inútiles sino también dañinos.
3. Comentarios básicos (se deben agregar)
(a) Comentarios para la clase (interfaz)
(b) Comentario del constructor
(c) Comentarios sobre métodos
(d) Comentarios de variables globales
(e) Notas para campos/atributos: el código simple hace comentarios simples, el contenido de comentarios no tiene más de 10 palabras, y además, persistes o objetos o
Los métodos de Getter y Setter de los objetos VO no necesitan ser comentados. Para formatos de anotación específicos, consulte los siguientes ejemplos.
4. Se deben agregar comentarios especiales (se deben agregar)
(a) Se deben comentar algoritmos típicos.
(b) Los comentarios deben hacerse en código poco claro.
(c) Agregue un comentario a la marca de modificación en la modificación del código.
(d) Comente en el código compuesto por bucles y ramas lógicas.
(e) Las interfaces proporcionadas a otras deben ser comentadas en detalle.
Nota: No hay ejemplos para este tipo de formato de comentarios. El formato de anotación específico se define por usted mismo, y el contenido de anotación se requiere para ser preciso y conciso.
5. Formato de comentarios:
1) Comentario de una sola línea: "// ..."
2) Bloquear comentario: "/*...*/"
3) Comentarios del documento: "/** ...*/"
4) Sintaxis de la etiqueta de comentarios de Javadoc
@Author La descripción de la clase indica que el autor que desarrolló el módulo de la clase
@version La descripción de la clase indica la versión del módulo de la clase
@See Reference Recurra a la descripción de clases, propiedades y métodos, es decir, temas relacionados
@param Descripción del método Descripción de un parámetro en un método
@return Descripción del método Descripción del valor de retorno del método
@Exception Descripción del método Descripción de las excepciones que pueden ser lanzadas por el método
6. Ejemplo:
/** Crear una clase de herramientas para manipular matrices, que contiene esta función común para las matrices operativas: el mayor valor. @author zhang san @versión v. */ public class ArrayTool {/ ** Obtenga el valor máximo de la matriz de configuración @param arr reciba una matriz de elementos de int type @return el valor de elemento máximo de la matriz */ public int getMax (int arr) {int max =; devolver max; }}Ingrese el comando como se muestra en la figura a continuación:
Luego verifíquelo en el siguiente directorio y finalmente haga clic en Index.html:
El contenido anterior comparte las especificaciones de comentarios del código Java con usted, con la esperanza de que sea útil para usted.