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 une feuille de triche aux développeurs de sites Web pour les aider à naviguer plus rapidement dans le code. Le commentaire dans le code est invisible pour l'utilisateur.

Alors, que veut dire commenter le code, et pourquoi cette fonctionnalité a-t-elle été conçue? Pour que tout soit clair pour vous maintenant, regardez des exemples sur la façon de commenter le code HTML, php, css, JavaScript et .htaccess.

Attention: les commentaires dans le code de chaque langage de programmation sont écrits différemment. Si vous ne respectez pas certaines règles, votre code risque de ne pas fonctionner.

Commentaires de code HTML

<!-- Для HTML -->

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

Sur le Web, les pages HTML sont généralement transmises aux navigateurs du serveur à l'aide des protocoles HTTP ou HTTPS, en texte brut ou à l'aide d'un cryptage.

Exemple avec:

  <html>
 <tête>
 <title> Commentaires en code HTML </ title>
 </ head>
 <body>
 <! - Cap 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: Hypertext Preprocessor - "PHP: Hypertext Preprocessor"; à 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. Actuellement pris en charge par la grande majorité des fournisseurs d'hébergement, il 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 un projet open source. Le projet est distribué sous sa propre licence, incompatible avec la GNU GPL.

Exemple avec:

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

Commentaires en code CSS

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

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

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

Exemple avec:

  .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 généralement utilisé comme langage incorporable pour accéder par programme aux objets de l'application. Le plus utilisé dans les navigateurs comme langage de script pour rendre les pages Web interactives.

Exemple avec:

  <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
 / * Compte à rebours à la fin du temps * /
 </ script>

Commentaires dans le code ".htaccess"

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

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

Les directives du 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 avec:

  # commenter protection spam bots
 RewriteEngine On
 RewriteCond% {REQUEST_METHOD} POST

Via bloggood.ru & wiki

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

Comment écrire du code immédiatement avec des commentaires

Essentiellement, 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 en réalité «Décrivez la structure du code avec des commentaires». Par exemple (très 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 squelette de commentaires est prêt, vous devez é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é, le TDD éprouvé. Il faut comprendre ici que s’écarter des commentaires, contrairement aux écarts de la logique des tests, n’aura pas de conséquences graves, eh bien, à moins que vous ne deviez réécrire les commentaires.

Comment commenter un code déjà 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 est logique de penser: ce qui n'est pas nécessaire pour 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 très exagéré):

  • Des choses très évidentes. Commentaires de la forme // on initialise le contre- enrage plus que leur absence
  • Le code incompréhensible ajoute un type de commentaire // n'a pas compris

En ce qui concerne le deuxième point, il convient d'expliquer un peu et de donner un exemple: insérez 100 lignes de code assembleur dans C! Vous la regardez et écrivez un commentaire // Beaucoup de livres! Niasilil

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

Enfin

En conclusion, je peux dire que l'art de rédiger des commentaires fait partie intégrante de l'art de programmer. Il est donc nécessaire de rédiger des commentaires. Aussi pathétique que cela puisse paraître, vous devez apprendre à rédiger des commentaires de haute qualité.