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

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

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

Pour commenter le code est d'écrire des commentaires dans le code.

Pour commenter le code est de laisser une feuille de triche texte pour les développeurs de sites Web pour les aider à naviguer dans le code plus rapidement. Le commentaire dans le code est invisible pour l'utilisateur.

Alors, qu'est-ce que cela signifie de commenter le code, et pourquoi cette possibilité a été inventée? Pour clarifier les choses pour vous maintenant, jetez un oeil à des exemples de comment commenter le code HTML, php, css, JavaScript et .htaccess.

Attention: les commentaires dans le code pour chaque langage de programmation sont prescrits différemment. Si vous ne suivez pas de règles spécifiques, votre code peut ne pas fonctionner.

Commentaires dans le code HTML

<!-- Для HTML -->

HTML (HyperText Markup Language) est un langage de balisage standardisé pour les documents sur le World Wide Web. La plupart des pages Web contiennent une description du balisage en HTML (ou XHTML). Le langage HTML est interprété par les navigateurs; Le texte formaté résultant est affiché sur l'écran d'un moniteur d'ordinateur ou d'un appareil mobile.

Dans le World Wide Web, les pages HTML sont généralement transmises aux navigateurs à partir du serveur via des protocoles HTTP ou HTTPS, en texte brut ou en utilisant le cryptage.

Exemple avec application:

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

Commentaires dans le code PHP

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

PHP (préprocesseur hypertexte - "PHP: hypertexte préprocesseur", à l'origine des outils personnels de page d'accueil - "Outils pour créer des pages Web personnelles") est un langage de script général utilisé largement pour développer des applications Web. Actuellement pris en charge par la grande majorité des fournisseurs d'hébergement et est l'un des leaders parmi les langues utilisées 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, ce qui est incompatible avec la GNU GPL.

Exemple avec application:

  <? php
 / * 1. Commentaire multi-ligne pour PHP * /
 echo "Exemple 1";  // 2. Un commentaire sur une seule ligne pour PHP
 echo "Exemple 2";  # 3. Un commentaire sur une seule ligne pour PHP
 ?>

Commentaires dans le code CSS

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

CSS (English Cascading Style Sheets) est un langage formel pour décrire l'apparence d'un document écrit en utilisant un langage de balisage.

Il est principalement utilisé comme un moyen de décrire, de visualiser l'apparence des pages Web écrites en utilisant les langages de balisage HTML et XHTML, mais peut également être appliqué à tout document XML, par exemple, à SVG ou XUL.

Exemple avec application:

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

Commentaires dans le code JavaScript

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

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

JavaScript est couramment utilisé en tant que langage intégré pour l'accès par programmation aux objets d'application. L'application la plus large se trouve dans les navigateurs en tant que langage de script pour donner de l'interactivité aux pages Web.

Exemple avec application:

  <script type = "text / javascript">
 / * Temps de comptage * /
 var RemainsSec = (parseInt (totalRemains / 1000));  // combien de secondes reste-t-il?
 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 gérer le fonctionnement du serveur Web et les paramètres du site en utilisant divers paramètres (directives) sans modifier le fichier de configuration principal du serveur Web.

Les directives pour le fichier .htaccess sont valides pour le répertoire dans lequel se trouve le fichier et pour tous ses sous-répertoires. S'il vous plaît, soyez prudent lors de l'édition du fichier .htaccess! Si vous enregistrez un tel fichier dans l'encodage UTF-8, il ne devrait pas y avoir de signature BOM.

Exemple avec application:

  # Protection du commentaire du spam bot
 RewriteEngine On
 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é au niveau inférieur. Je ne me souviens pas comment cela sonnait dans l'original, mais en substance "Décrivez la structure des commentaires de code." Sur un exemple (fortement exagéré, pourquoi - ci-dessous) le code du programme, qui ajoute deux chiffres, ce principe ressemblera à ceci:

  int main ()
 {
  // Accepte deux nombres de l'utilisateur
  // Crée une variable pour le résultat de l'addition
  // Renvoie le résultat de l'addition

  renvoie 0;
 }

Et seulement lorsque le cadre est préparé à partir des commentaires, il est nécessaire d'écrire du code qui implémentera ce qui est décrit par les commentaires.

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

  renvoie 0;
 }

Comme mentionné ci-dessus, ce principe est un principe modifié, un TDD bien éprouvé. Il faut comprendre que l'écart par rapport aux commentaires, contrairement à l'écart par rapport à la logique des tests, n'entraînera pas de conséquences sérieuses, à moins de devoir réécrire les commentaires.

Comment commenter un code existant

La réponse à cette question est assez simple: commenter les entités du parent au descendant: class -> méthode -> code à l'intérieur de la méthode (si nécessaire) .

Il est tout à fait logique de penser: quoi ne pas commenter. Vous n'avez pas besoin de commenter dans deux cas (l'un d'eux explique pourquoi l'exemple de code ci-dessus était fortement exagéré):

  • Des choses absolument évidentes. Les commentaires du formulaire // initialisent le compteur plus que leur absence
  • Le code incompréhensible est complété par un commentaire de type // rien compris

Concernant le deuxième item, il vaut la peine d'expliquer un peu et de donner un exemple: insérer 100 lignes de code assembleur en C! Vous le regardez et écrivez un commentaire // Beaucoup de bukaf! Nyasilil

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

Enfin

En conclusion, je peux dire que l'art d'écrire des commentaires fait partie intégrante de l'art de la programmation, c'est pourquoi vous devez écrire des commentaires, et, comme cela peut sembler pathétique, mais il est nécessaire d'apprendre des commentaires qualitatifs.