Comment commenter dans jQuery

Comment utiliser les commentaires dans jQuery , Automatisez vos commentaires à l'aide d'un plugin et commentaires efficacement les commentaires de flottaison les utilisent efficacement.

Commentaires de base jQuery

Les commentaires de jQuery sont lancés par une double barre de barre avant qui indique à l'interprète que le texte suivant sur la ligne ne doit pas être traité comme JavaScript. Les commentaires de jQuery peuvent être à l'intérieur d'une fonction ou à l'extérieur, il ne fait aucune différence.

<span>function myFunction ( myVar<span>, myVar2</span> ) {
</span><span>// Pay attention to spaces around
</span><span>// the brackets and curly brackets
</span><span>}</span>

<span>// some prefere it like this
</span><span>function myFunction()
</span><span>{
</span><span>...
</span><span>}</span>

Commentaires jQuery multi-lignes

Multi-line jQuery comments are enclosed within a combination of a forward slash and an asterisk like so:
<pre class="brush:php;toolbar:false">

/ * commentaire * /

jQuery Commentant les directives

Voici quelques conseils pour commenter JQuery:

1. Les longs commentaires devraient utiliser / * ... * /.
2. Les commentaires de ligne unique devraient toujours être sur leur propre ligne et être Au-dessus de la ligne, ils font référence. De plus, il devrait y avoir un Endline supplémentaire au-dessus. Par exemple:

<span>var some = "stuff";
</span>
   <span>// We're going to loop here
</span>   <span>for ( var i = 0; i < 10; i++ ) {}</span>

Source: http://docs.jquery.com/jquery_core_style_guidelines

Les questions fréquemment posées (FAQ) sur les commentaires jQuery

Quel est le but d'utiliser des commentaires dans jQuery?

Les commentaires dans jQuery, comme dans tout autre langage de programmation, sont utilisés pour expliquer le code et le rendre plus compréhensible. Ils ne sont pas exécutés par le navigateur, mais ils fournissent des informations précieuses aux développeurs qui pourraient lire le code. Cela peut être particulièrement utile dans des projets complexes où le code pourrait ne pas être explicite. Les commentaires peuvent également être utilisés pour désactiver temporairement certaines parties du code pendant le débogage.

Comment puis-je ajouter un commentaire à une seule ligne dans jQuery?

Les commentaires à une seule ligne dans jQuery peuvent être ajoutés à l'aide de deux barres obstruées (//) au début de la ligne. Le navigateur ignorera tout après les barres obliques sur cette ligne. Par exemple:
// Ceci est un commentaire en une seule ligne dans jQuery

comment puis-je ajouter un commentaire multi-lignes dans jQuery?

Les commentaires multi-lignes en jQuery commencent par / * et se terminent par * /. Tout entre ces symboles est considéré comme un commentaire et sera ignoré par le navigateur. Par exemple:
/ * Ceci est un commentaire multi-ligne
dans jQuery * /

puis-je utiliser des commentaires dans une fonction jQuery?

Oui, vous pouvez utiliser à la fois des commentaires à ligne unique et multi-lignes dans une fonction jQuery. Ils peuvent être utilisés pour expliquer ce que fait la fonction ou pour clarifier les parties complexes de la fonction.

Comment puis-je désactiver temporairement une partie de mon code en utilisant les commentaires?

Vous pouvez temporairement désactiver une partie de votre code en le transformant en commentaire. Cela peut être utile lorsque vous déboguez votre code et que vous souhaitez en isoler certaines parties. Pour ce faire, joignez simplement la partie du code que vous souhaitez désactiver / * et * /.

Les commentaires peuvent-ils affecter les performances de mon site Web?

Non, les commentaires dans jQuery n'affectent pas les performances de votre site Web. Ils sont complètement ignorés par le navigateur et n'ont aucun impact sur l'exécution de votre code.

Comment utiliser les commentaires pour créer une documentation de plugin jQuery?

Lors de la création d'un plugin jQuery, c'est une bonne pratique pour utiliser les commentaires pour documenter le fonctionnement du plugin. Cela peut inclure des informations sur l'objectif du plugin, comment l'utiliser, quels paramètres il accepte, ce qu'il renvoie et toutes les dépendances qu'il pourrait avoir.

Puis-je utiliser des balises HTML dans les commentaires jQuery?

Non, les balises HTML ne sont pas autorisées dans les commentaires jQuery. Si vous essayez de les utiliser, ils seront traités comme faisant partie du commentaire et seront ignorés par le navigateur.

Quelle est la différence entre les commentaires dans jQuery et les commentaires en javascript?

Il n'y a pas de différence entre les commentaires dans jQuery et les commentaires en javascript. JQuery est une bibliothèque construite sur JavaScript, il utilise donc la même syntaxe pour les commentaires.

Puis-je utiliser des commentaires dans jQuery pour laisser des notes pour moi-même ou d'autres développeurs?

Oui, l'une des principales utilisations des commentaires de jQuery est de laisser des notes ou d'autres développeurs. Ces notes peuvent concerner tout ce qui concerne le code, comme expliquer ce qu'une certaine partie du code fait, pourquoi une certaine décision a été prise, ou ce qui doit être fait à l'avenir.

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!