Un buen estilo de codificación puede ayudarnos a tener ideas claras a la hora de crear páginas web, y los comentarios del código también tienen algunos pequeños conocimientos.
Resumí los estándares de redacción de anotaciones que utilicé en mi trabajo. De hecho, no hay contenido técnico. Lo principal es prestar atención a los estándares, lo que facilita el método de producción unificado y facilita el mantenimiento.
Estas experiencias incluyen cuatro partes: "Comentarios de región", "Comentarios de una sola línea", "Niveles de comentarios" y "Comentarios asistidos". El método de anotación de área utilizado por la mayoría de los amigos comenzará con "contenido de la anotación" o "final del contenido de la anotación", "inicio" o "fin", etc. En comparación, comenzar con "S" o "E" puede ser más rápido. use, por ejemplo, simplemente escriba el comentario inicial o final una vez, luego cópielo y cambie la "S" o la "E" para completar rápidamente el comentario en el área.
En el trabajo real, a veces no está claro si la anotación debe estar encima o debajo de la etiqueta. Para evitar esta situación, la información de la anotación se escribe uniformemente antes y después del principio y el final de la etiqueta de la región, y está precedida por "S". " o
"
E " comienza, indicando el comienzo o el final de la anotación del área.Ejemplo:
<!--=S contenido del comentario-->
<div>
...
</div>
<!--=E Contenido del comentario-->
/*=S Contenido del comentario*/
.clase{
...
}
.clase{
...
}
/*=E Contenido del comentario*/
comentario de una sola línea
debe escribirse en el área de contenido que debe comentarse.
Ejemplo:
<div>.
<!--Contenido del comentario-->
...
</div>
.clase{
/*Contenido del comentario*/
...
}
Nivel de anotación
En la producción de módulos, puede haber áreas dentro de áreas. Para distinguir mejor los niveles entre áreas, se introduce el concepto de nivel de anotación. El signo igual delante del comentario del área indica el nivel del comentario actual.
Ejemplo:
<!--=S contenido del comentario-->.
...
<!--==S Contenido del comentario-->
...
<!--===S Contenido del comentario-->
...
<!--===E Contenido del comentario-->
...
<!--==E Contenido del comentario-->
...
<!--=E Contenido del comentario-->
/*=S Contenido del comentario*/
...
/*==S Contenido del comentario*/
...
/*===Contenido del comentario S*/
...
/*===E Contenido del comentario*/
...
/*==E Contenido del comentario*/
...
/*=E Contenido del comentario*/
Ayuda a comentar
información de identificación, como la hora de modificación y el modificador agregado cuando lo mantienen personas que no son autores. Agregue el modificador y la hora de modificación y otra información según el comentario del área o el comentario de una sola línea.
Ejemplo (comentario de región):
<!--==S contenido del comentario [modificador y hora de modificación]-->
<div>
...
</div>
<!--==E Contenido del comentario [modificador y hora de modificación]-->
/*=S Contenido del comentario [modificador y hora de modificación]*/
.clase{
...
}
.clase{
...
}
/*=E Contenido del comentario [modificador y hora de modificación]*/
Ejemplo (comentario de una sola línea):
<div>
<!-- Contenido del comentario [modificador y hora de modificación]-->
...
</div>
.clase{
/*Contenido del comentario [modificador y hora de modificación]*/
...
}