Le rôle et la démonstration de l'utilisation des commentaires de code dans le développement front-end

Lorsque nous écrivons des pages, les commentaires sont un élément indispensable. D'une part, les commentaires peuvent vous permettre de voir clairement la structure du code, ce qui le rend plus facile à trouver. D'autre part, ils sont également propices au transfert de travail entre les deux. collègues. Bien sûr, Les commentaires de code doivent également être standardisés à l'aide de . Alors aujourd'hui je vais vous parler des Annotations du code front-end Les amis dans le besoin peuvent s'y référer, j'espère que cela vous sera utile.

1. À quoi servent les commentaires de code ?

1 Il a la même fonction que le pseudo-code, écrire une idée d'algorithme directeur pour la fonction à implémenter. suivant. Mais pas aussi détaillé que le pseudocode. Cependant, l’idée générale de l’algorithme pour remplir cette fonction est également soulignée.
2. Donnez une note explicative à ceux qui liront le code. Notez que les seules personnes qui consultent le code sont vous-même. Permettez aux personnes qui consultent votre code de parcourir rapidement votre code sans avoir à le lire ligne par ligne à chaque fois qu'ils le lisent afin de comprendre ce que vous avez écrit.

2. Spécifications des commentaires du code, suivez les principes suivants

1 Peut aider les lecteurs à mieux comprendre la logique et la structure du code
2. de la méthode d'écriture peut être expliquée
3. Commentaires de marques spéciales : telles que TODO, FIXME et autres marques ayant une signification particulière
4. Commentaires de fichier : Certaines réglementations exigeront l'écriture de commentaires au format fixe en tête du fichier , comme indiquer l'auteur, le protocole et d'autres informations
5. Commentaires sur la documentation : certaines réglementations exigent que les classes, fonctions, etc. d'API utilisent des commentaires de documentation (tels que le style jsdoc)
6. Suivez les spécifications de style unifiées, telles que certains espaces et lignes vides, Pour assurer la lisibilité des commentaires eux-mêmes

3. Comment rédiger des commentaires de code

1. Contenu du commentaire -->;

<!-- html中要注释的内容 -->
在web页面中，最常见的注释就是这种了。我们在布局页面结构的时候，会添加少许的注释方便我们查找与记忆我们的想法。
那么在页面中除了这样的注释外，还有那些注释呢，这里我列举一些：
If条件不同版本浏览器注释列表：
<!--[if !IE]>除IE外都可识别<![endif]--> 
<!--[if IE]> 所有的IE可识别 <![endif]-->
<!--[if gt IE 5.0]> IE5.0以及IE5.0以上版本都可以识别 <![endif]--> 
<!--[if IE 6]> 仅IE6可识别 <![endif]--> 
<!--[if lt IE 6]> IE6以及IE6以下版本可识别 <![endif]--> 
<!--[if gte IE 6]> IE6以及IE6以上版本可识别 <![endif]--> 
<!--[if IE 7]> 仅IE7可识别 <![endif]--> 
<!--[if lt IE 7]> IE7以及IE7以下版本可识别 <![endif]--> 
<!--[if gte IE 7]> IE7以及IE7以上版本可识别 <![endif]-->

2. Commentaires du code CSS : /* Contenu du commentaire*/

Différent du formulaire de commentaire en html, les commentaires en css prennent la forme de /*commentaires sous forme css*/. Il n’y a pas une seule ou plusieurs lignes de contenu de commentaire.

/*.aa,.bb {
                height: 100px;
                margin: 1px;
                background: #ccc;
            }*/

3. Commentaires du code JS : //Contenu du commentaire ou /* Contenu du commentaire*/,

Différents du htmlcss, les commentaires en js ont des distinctions sur une seule ligne et sur plusieurs lignes. , et il en existe de nombreux types. Présentons-les un par un ci-dessous.
(1) // Deux barres obliques représentent un commentaire sur une seule ligne.
(2) Utilisez comme commentaire sur une seule ligne.
(3) /* * / Commentaires multilignes

//          function out(obj){
//              obj.innerHTML = "移出了";
//              obj.style.background = "#ccc";        
//          }

Résumé : les développeurs front-end doivent avoir une compréhension approfondie du but et des principes des commentaires de code, suivre les conventions de commentaires et les utiliser en conjonction avec des outils, afin que les commentaires puissent devenir une bonne partie du code. Assistance pour améliorer la lisibilité et la maintenabilité, améliorant ainsi la qualité du code.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!