Un bon style de codage peut nous aider à avoir des idées claires lors de la création de pages Web, et les commentaires du code ont également quelques connaissances.
J'ai résumé les normes d'écriture d'annotations que j'ai utilisées dans mon travail. En fait, il n'y a pas de contenu technique. L'essentiel est de faire attention aux normes, ce qui facilite la méthode de production unifiée et facilite la maintenance.
Ces expériences comprennent quatre parties : « Commentaires de région », « Commentaires sur une seule ligne », « Niveaux de commentaires » et « Commentaires assistés ». La méthode d'annotation de zone utilisée par la plupart des amis commencera par "contenu de l'annotation" ou "fin du contenu de l'annotation", "début" ou "fin", etc. En comparaison, commencer par "S" ou "E" peut être plus rapide. utilisez, par exemple, écrivez simplement le commentaire de début ou de fin une fois, puis copiez-le et modifiez le « S » ou le « E » pour compléter rapidement le commentaire dans la zone.
Dans le travail réel, il n'est parfois pas clair si l'annotation doit être au-dessus ou en dessous de l'étiquette. Afin d'éviter cette situation, les informations d'annotation sont écrites uniformément avant et après le début et la fin de l'étiquette de région et sont précédées de "S". " ou
"
E " commence, indiquant le début ou la fin de l'annotation de zone.Exemple :
<!--=S contenu du commentaire-->
<div>
...
</div>
<!--=E Contenu du commentaire-->
/*=S Contenu du commentaire*/
.classer{
...
}
.classer{
...
}
/*=E Contenu du commentaire*/
commentaire sur une seule ligne
doivent être écrites dans la zone de contenu qui doit être commentée.
Exemple :
<div>.
<!--Contenu du commentaire-->
...
</div>
.class{
/*Contenu du commentaire*/
...
}
Niveau d'annotation
Dans la production de modules, il peut y avoir des zones à l'intérieur des zones. Afin de mieux distinguer les niveaux entre les zones, la notion de niveau d'annotation est introduite. Le signe égal devant le commentaire de zone indique le niveau du commentaire actuel.
Exemple :
<!--=S comment content-->.
...
<!--==S Contenu du commentaire-->
...
<!--===S Contenu du commentaire-->
...
<!--===E Contenu du commentaire-->
...
<!--==E Contenu du commentaire-->
...
<!--=E Contenu du commentaire-->
/*=S Contenu du commentaire*/
...
/*==S Contenu du commentaire*/
...
/*===Contenu du commentaire S*/
...
/*===E Contenu du commentaire*/
...
/*==E Contenu du commentaire*/
...
/*=E Contenu du commentaire*/
Aide au commentaire
des informations d'identification telles que l'heure de modification et le modificateur ajoutés lorsqu'ils sont maintenus par des non-auteurs. Ajoutez le modificateur et l'heure de modification ainsi que d'autres informations en fonction du commentaire de zone ou du commentaire sur une seule ligne.
Exemple (commentaire de région) :
<!--==S contenu du commentaire [modificateur et heure de modification]-->
<div>
...
</div>
<!--==E Contenu du commentaire [modificateur et heure de modification]-->
/*=S Contenu du commentaire [modificateur et heure de modification]*/
.classer{
...
}
.classer{
...
}
/*=E Contenu du commentaire [modificateur et heure de modification]*/
Exemple (commentaire sur une seule ligne) :
<div>
<!-- Contenu du commentaire [modificateur et heure de modification]-->
...
</div>
.class{
/*Contenu du commentaire [modificateur et heure de modification]*/
...
}