====== Commenter ======

  * Objet : Les commentaires
  * Niveau requis : {{tag>débutant avisé}}
  * Commentaires : //Commenter une ligne de configuration. //
  * Débutant, à savoir : [[:doc:systeme:commandes:le_debianiste_qui_papillonne|Utiliser GNU/Linux en ligne de commande, tout commence là !.]] :-)
  * Suivi : 
    * Création par [[user>smolski]] le 04/10/2013
    * Testé par [[user>smolski]] le 04/10/2013
  * Commentaires sur le forum : [[http://debian-facile.org/viewtopic.php?id=7532 | Lien vers le forum concernant ce tuto]] ((N'hésitez pas à y faire part de vos remarques, succès, améliorations ou échecs !))


===== Introduction =====

Les fichiers de configuration abondent de titres et d'indications supplémentaires permettant à l'administrateur de comprendre le sens d'une option facultative ou non mises en aparté dans les fichiers qu'il administre.

Pour obtenir cela, on utilise un caractère __spécifique selon les contextes__ devant chacune des lignes qui ne doit pas être interprétée par le système. 8-)

===== Exemple =====

Dans le contexte d'un [[doc:programmation:bash | shell bash]] par exemple le dièse((nommé aussi : croisillon)) :  ''  # ''  mis en tête de la ligne à commenter permet au système d'en ignorer le contenu tout en l'affichant textuellement.
Exemple ici :
  * [[doc:systeme:apt:sources.list?&#introduction | Commenter la ligne source d'installation restant d'origine attachée au support.]]

Également, des titrages sont ainsi rendus possibles en cumulant quelques dièses '' # '' (leur nombre dépend uniquement de l'esthétisme fonctionnel qu'ils représentent). \\
Exemple :
D'origine dans le fichier d'une configuration, par exemple dans le fichier /''etc/apache2/apache2.conf'' ici :
<file bash>
##
## Server-Pool Size Regulation (MPM specific)
## 

# prefork MPM
</file>
Où le titrage écrit avec des dièses doubles est une mise en valeur de ce qui suit. \\
L'option commentée ''# prefork MPM'' est indiquée mais inactive avec le dièse placé devant.

Ou en titrage élaboré dans un script personnel :
<file bash>
########################################
## Gestion des appels simultannés

# Affiche un warning et quitte si le programme tourne, continue sinon
function verif_verrou ()
{
if [ -f "$LOCK" ];    # On regarde si le verrou existe
then
  # Auquel cas, on affiche un message d'erreur et on quitte en renvoyant le statut d'erreur : 1 ...
</file>
//Pass'que des fois on s'souvient pus très bien qui fait quoi dans c'qui est fabriqué !// :-D \\
Ici, seules les lignes sans dièse sont lues et interprétées par le système pour l'exécution de cette fonction.

Ou encore en signature à la fin d'un script issu de la main d'un geek bien poilu mais souriant :
<file bash>
# C'est fini Nini !

# vim:set ft=sh tw=0 foldmethod=marker:  
</file>
//Et oui, y'en a des comm' ça, y faut croire que la pizza cong'lée ne rend pas morose !// :-D

== Nota ==

Le commentaire indiquant le contexte du shell d'un script, par exemple : **#!/bin/bash** est lu par le système au lancement, mais ignoré par l'interpréteur, c'est l'appel système exec* qui interprète le ''#! /bin/bash''

//Merci de ces renseignements à //**enicar**// et au //**captnfab**// en harmonie tous deux sur le salon irc df !// :-)
===== Remarque =====

Tous les fichiers de conf n'utilisent pas le # comme commentaire !

  * Par exemple pour le ''.Xdefaults'' / ''.xresources'' c'est le point virgule '';'' qui fait office de commentaire
  * pour samba, le point virgule '';'' et le dièse ''#'' sont tous deux utilisés pour commenter
  * pour Abiword, c'est du xml, donc les commentaires sont indiqués entre les balises ''<!-%%-%%'' et ''-%%->%%''
  * ario //idem//
  * awesome, il faut mettre deux tirets ''%%--%%'' en début de ligne (c'est du lua)
  * brasero, xml //aussi//

//Précisions du //**captnfab**// là !// :-)