This page has been robot translated, sorry for typos if any. Original content here.

Comment commenter le code en HTML, PHP, JavaScript, CSS, .htaccess?

Как закомментировать код

Commenter le code signifie écrire des commentaires dans le code.

Commenter le code signifie laisser un aide-mémoire aux développeurs de sites Web pour les aider à naviguer plus rapidement dans le code. Le commentaire dans le code n'est pas visible pour l'utilisateur.

Alors, que signifie commenter le code, et pourquoi cette fonctionnalité a-t-elle été inventée? Pour tout clarifier pour vous maintenant, regardez des exemples sur la façon de commenter le code HTML, php, css, JavaScript et le code .htaccess.

Remarque: les commentaires dans le code de chaque langage de programmation sont écrits différemment. À moins que vous ne respectiez des règles spécifiques, votre code pourrait ne pas fonctionner.

Commentaires HTML

<!-- Для HTML -->

HTML (de l'anglais HyperText Markup Language - «Hypertext Markup Language») est un langage de balisage de document normalisé sur le Web. La plupart des pages Web contiennent des descriptions de balisage HTML (ou XHTML). HTML est interprété par les navigateurs; le texte formaté qui en résulte est affiché sur l'écran d'un ordinateur ou d'un appareil mobile.

Sur le Web, les pages HTML sont généralement transmises aux navigateurs du serveur via HTTP ou HTTPS, en texte brut ou par cryptage.

Exemple d'application:

  <html>
 <tête>
 <title> Commentaires en HTML </ title>
 </ head>
 <body>
 <! - En-tête du site ->
 <img src = "kartinka.png">
 <! - fin de l'en-tête du site ->
 </ body>
 </ html>

Commentaires en code PHP

/* 1. Многострочный комментарий для PHP */ // 2. Однострочный комментарий для PHP # 3. Однострочный комментарий для PHP

PHP (PHP: préprocesseur hypertexte en anglais - «PHP: préprocesseur hypertexte»; à l'origine, Outils de page d'accueil personnelle - «Outils de création de pages Web personnelles») est un langage de script à usage général largement utilisé pour développer des applications Web. Il est actuellement pris en charge par la grande majorité des fournisseurs d'hébergement et est l'un des leaders parmi les langages utilisés pour créer des sites Web dynamiques.

Le langage et son interprète (Zend Engine) sont développés par un groupe de passionnés dans le cadre d'un projet open source. Le projet est distribué sous sa propre licence, incompatible avec la GNU GPL.

Exemple d'application:

  <? php
 / * 1. Commentaire multiligne pour PHP * /
 echo "Exemple 1";  // 2. Commentaire d'une ligne pour PHP
 echo "Exemple 2";  # 3. Un commentaire de ligne pour PHP
 ?>

Commentaires CSS

/* комментарий в css */

CSS (Cascading Style Sheets - feuilles de style en cascade) est un langage formel permettant de décrire l'apparence d'un document écrit à l'aide d'un langage de balisage.

Il est principalement utilisé pour décrire et concevoir l'apparence des pages Web écrites à l'aide des langages de balisage HTML et XHTML, mais peut également s'appliquer à tout document XML, par exemple, SVG ou XUL.

Exemple d'application:

  .p
 {
 police: 25px "Times New Roman", Times, serif;  / * Police et taille du texte * /
 }

Commentaires de code JavaScript

// Однострочный комментарий для JavaScript /* Многострочный комментарий для JavaScript */

JavaScript (abbr. JS) est un langage de programmation multi-paradigmes. Prend en charge les styles orientés objet, impératifs et fonctionnels. C'est une implémentation du langage ECMAScript (norme ECMA-262).

JavaScript est couramment utilisé comme langage intégré pour accéder par programme aux objets de l'application. Il est surtout utilisé dans les navigateurs comme langage de script pour donner une interactivité aux pages Web.

Exemple d'application:

  <script type = "text / javascript">
 / * Compte à rebours * /
 var RemainsSec = (parseInt (totalRemains / 1000));  // combien de secondes il reste
 var RemainsFullDays = (parseInt (RemainsSec / (24 * 60 * 60)));  // jours restants
 / * Fin du compte à rebours * /
 </ script>

Commentaires dans le code .htaccess

# Описание инструкции

.htaccess est le fichier de configuration du serveur Web Apache qui vous permet de contrôler le fonctionnement du serveur Web et les paramètres du site à l'aide de divers paramètres (directives) sans modifier le fichier de configuration principal du serveur Web.

Les directives de fichier .htaccess s'appliquent au répertoire dans lequel se trouve le fichier et à tous ses sous-répertoires. S'il vous plaît soyez prudent lorsque vous modifiez le fichier .htaccess! Lorsque vous enregistrez un tel fichier au format UTF-8, il ne doit pas contenir de signatures de nomenclature.

Exemple d'application:

  Protection des commentaires contre le spam
 Réécrire le moteur sur
 RewriteCond% {REQUEST_METHOD} POST

Via bloggood.ru & wiki

Как закомментировать код

Comment écrire du code immédiatement avec des commentaires

En fait, le principe de TDD (développement piloté par les tests, développement par test) a été déplacé à un niveau inférieur. Je ne me souviens pas comment cela sonnait dans l’original, mais essentiellement «Décrivez la structure du code avec des commentaires». Sur l'exemple (fortement exagéré, pourquoi - ci-dessous) du code de programme qui ajoute deux nombres, ce principe va ressembler à ceci:

  int main ()
 {
  // recevoir deux numéros de l'utilisateur
  // Crée une variable pour le résultat de l'addition
  // retourne le résultat de l'addition

  retourne 0;
 }

Et seulement lorsque le cadre des commentaires est prêt, devriez-vous écrire du code qui implémentera ce qui est décrit par les commentaires.

  ...
 int main ()
 {
  double a, b;
  // recevoir deux numéros de l'utilisateur
  cin >> a;
  cin >> b;
  // Crée une variable pour le résultat de l'addition
  double somme = a + b;
  // retourne le résultat de l'addition
  cout << somme;

  retourne 0;
 }

Comme mentionné ci-dessus, ce principe est un principe modifié du TDD bien établi. Il faut comprendre que les écarts par rapport aux commentaires, par opposition aux écarts par rapport à la logique des tests, n'entraîneront pas de conséquences graves, eh bien, sauf si vous devez réécrire les commentaires.

Comment commenter le code existant

La réponse à cette question est assez simple: nous commentons les entités de parent à enfant: class -> méthode -> code dans la méthode (si nécessaire) .

Il serait logique de penser: et ce qui n'a pas besoin de commenter. Il n'est pas nécessaire de commenter dans deux cas (l'un d'eux explique pourquoi l'exemple de code ci-dessus était grandement exagéré):

  • Des choses assez évidentes. Commentaires de la forme // initialise le compteur enragé plus que leur absence
  • Ajoutez du code incompréhensible avec un commentaire comme // ne comprend rien

En ce qui concerne le deuxième point, il est utile d’expliquer un peu et de donner un exemple: insérer 100 lignes de code C assembleur! Vous le regardez et écrivez un commentaire // Beaucoup de bukaf! Niasilil

Après cela, la personne qui est venue chez vous après votre licenciement voit ce commentaire et ... c'est tout! Il n'essayera même pas de le comprendre, et votre enregistrement sera un stigmate sur ce morceau de code jusqu'à ce qu'il soit supprimé (le code ou le commentaire).

À la fin

En conclusion, je peux dire que l'art de rédiger des commentaires fait partie intégrante de l'art de programmer. Vous devez donc rédiger des commentaires, et peu importe à quel point cela semble pathétique, vous devez apprendre à rédiger des commentaires de haute qualité.