Comment ajouter des commentaires de code ?

Vous pouvez passer le code : //comment, /*comment*/, , #comment, '''comment''', --comment, 'comment, % commenter et ainsi de suite pour ajouter des commentaires. L'article suivant vous présentera les méthodes d'annotation de code par catégorie. J'espère qu'il vous sera utile.

Méthodes courantes de commentaires de code :

Commentaire HTML

<!--这里是注释-->

Commentaires CSS

/*这里是注释*/

Commentaires JavaScript

Commentaires sur une seule ligne :

//这里是注释

Commentaires en bloc (multi-lignes) :

/*这里是注释*/

Commentaires XML

<!--这里是注释-->

Commentaires sur le code C/C++/C#

Commentaires sur une seule ligne :

//这里是注释

Commentaires en bloc (multilignes) :

/*这里是注释*/

Java commentaires

Commentaires sur une seule ligne :

//这里是注释

Commentaires en bloc (multi-lignes) :

/*这里是注释*/

Commentaires Python

Commentaires sur une seule ligne :

#这里是注释

Commentaires en bloc (multilignes) :

'''这里是注释'''

Commentaires VB

'这是一个单行注释

Remarque : Il s'agit d'une simple citation suivie d'un commentaire

commentaire perl

Commentaire sur une seule ligne :

# 这是一个单行注释

Commentaires en bloc (multilignes) :

=pod 
这里是注释
=cut

Commentaires Matlab

Commentaires sur une seule ligne :

%这里是注释

Commentaires en bloc (multi-lignes) :

%%这里是注释%%
%{这里是注释%}

Commentaires en langue R

Commentaires sur une seule ligne :

#这里是注释

Bloquer les commentaires (multilignes) :

if(false){这里是注释}

Pourquoi ajouter des commentaires ?

Les commentaires sont des « indices » ou des « explications » du code, et non de la documentation ; les commentaires sont principalement utilisés pour expliquer la complexité du code ; les commentaires doivent être précis et faciles à comprendre (sans ambiguïté ; ) sexe) et concis ; le nombre de commentaires efficaces dans le programme doit être supérieur à 20 % ; C'est définitivement une bonne habitude d'ajouter des commentaires au code. Il est préférable de commenter lors de l'écriture du code

Le but des commentaires : faciliter la maintenance du code, expliquer les fonctions et méthodes du code à faciliter la lecture des lecteurs et éviter la duplication inutile des informations .

Remarque : si le code est clair et peut être auto-annoté, il n'est pas nécessaire d'ajouter des commentaires. Des commentaires trop détaillés peuvent facilement ennuyer les gens. N'oubliez pas de ne pas penser que les autres ne peuvent pas le comprendre sans ajouter de commentaires.

Ce qui précède représente l’intégralité du contenu de cet article, j’espère qu’il sera utile à l’étude de chacun. Pour un contenu plus passionnant, vous pouvez prêter attention aux colonnes de didacticiels pertinentes du site Web PHP chinois ! ! !

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!