Compréhension approfondie des méthodes d'annotation de code JS et des spécifications d'annotation de code

Lors de la mise en page, afin d'améliorer la lisibilité du code, il est souvent nécessaire d'ajouter des commentaires au code. Cet article vous expliquera comment annoter le code JS et les spécifications des commentaires du code JS. je peux m'y référer. J'espère que cela aidera !

Les commentaires sont une partie essentielle du code, et un programme complet doit être commenté. Les commentaires vous aident non seulement à mettre à jour et à modifier le projet, mais aident également les autres à savoir ce que vous avez écrit lorsqu'ils reçoivent votre projet.

1. Méthode de commentaire du code JavaScript

JavaScript n'exécutera pas le code dans le commentaire. Les commentaires du code JS sont divisés en commentaires sur une seule ligne et multi-. commentaires de ligne.

1. Commentaires sur une seule ligne

Les commentaires sur une seule ligne commencent par //, ajoutez un espace après //, puis écrivez le contenu du commentaire. pour décrire la fonction du code actuel et expliquer le code, etc.

Exemple de code : commenter une seule ligne du code document.write("string is:"+str) sans qu'elle soit affichée sur la page

<script type="text/javascript">
  function myFunction(){
   var animal = ["dog", "cat", "elephant", "tiger"];
   var str=animal.toString();
   document.write("类型是："+typeof(str));  
   //document.write("字符串是:"+str)
  }  
 </script>

Rendu avant commentaire :

Rendu après commentaire :

Commentaires multi-lignes

Les commentaires multi-lignes commencent par /* Commencez par */, mais essayez d'utiliser des commentaires sur une seule ligne au lieu de commentaires sur plusieurs lignes dans votre travail. Même si le commentaire nécessite plusieurs lignes, il doit être complété par un commentaire sur une seule ligne. pour utiliser des commentaires multilignes pour les commentaires de fonction.

Exemples de code :

<script>
/*
下面的这些代码会输出
一个标题和一个段落
并将代表主页的开始
*/
document.getElementById("myH1").innerHTML="欢迎来到菜鸟教程";
document.getElementById("myP").innerHTML="这是一个段落。";
</script>

2. Spécifications pour les commentaires de code JS

Un bon commentaire de code doit être fait si c'est le cas. n'est pas nécessaire, n'ajoutez pas de commentaires. Si vous devez ajouter des commentaires, écrivez-les en détail pour permettre aux autres de comprendre ce que vous voulez dire et essayez d'améliorer la clarté et la lisibilité du code. Les points suivants doivent être atteints pendant le travail :

1. Dans le code logique, les commentaires de code doivent être supérieurs à 20 %

2. Lorsque des commentaires de fichier sont effectués, les commentaires de fichier doivent être écrits dans le fichier. file. Header

3. Lors des commentaires sur les classes et les interfaces, les commentaires doivent être placés avant la classe et après les mots-clés using ou package

4. , commentaires Il doit être écrit sur les attributs de classe, les méthodes publiques et protégées. Utilisez simplement //Comments, vous devez aligner le code commenté

5. Les commentaires doivent être placés devant le code commenté, écrire sur des lignes séparées et ne pas laisser de lignes vides au milieu

6. Ne les mettez pas dans les commentaires. Utilisez des abréviations. Si vous souhaitez utiliser des abréviations, vous devez fournir les explications nécessaires pour les abréviations

7. Lors de l'annotation du contenu des variables membres, la signification, le but et la fonction. des variables membres, et là où elles peuvent être utilisées, utilisez // pour Les commentaires doivent aligner le code commenté

En bref, chaque programmeur devrait développer une bonne habitude d'écrire des commentaires, ce qui non seulement facilite vous permet de lire et de modifier le code, mais permet également aux autres de comprendre et de gérer plus facilement votre code.

Ce qui précède présente la méthode d'annotation du code JS et les spécifications d'annotation du code JS. C'est relativement simple et facile à comprendre. Pour plus de didacticiels connexes, veuillez visiter le Tutoriel vidéo JavaScript

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!