Suite à une « échauffourée »
avec Argolance sur ce fil, j'ai produit un script qui lit la plupart des commentaires dans un script :
Code: Select all
#!/bin/ash
# /root/my-applications/bin/lit-commentaires.sh
#
# Objectif : extraire les commentaires d'un script
# ------------ pour renseigner l'utilisateur.
#
# Usage : lit-commentaires.sh < nom du script >
#
# Exemple : lit-commentaires.sh lit-commentaires.sh
#
# (c), musher0, 3i janvier 2019. GPL3.
####
echo -e "\n\t\e[4;1;33mEn-tête du script :\e[0m\n"
while read line;do
if [ "${line:0:4}" = "####" -o "${line:0:3}" = "###" ];then
echo $line
echo -e "\n\t\e[4;1;33mNotes à la fin du script :\e[0m\n"
grep -A 5000 ^exit $1 | more # lit la fin, puis
echo
exit
elif [ "${line:0:1}" = "#" ];then
# En général l'en-tête du script.
echo $line
fi
done < $1 | more
exit
Notes :
1) C'est très simple, comme vous le constatez.
Il faut cependant que les dièzes introduisant les
commentaires soient exactement dans la 1ère
colonne, ainsi que le mot « exit ».
Concernant l'en-tête, tous les scripts en ont une.
Mais tous les scripts ne comportent pas la mention
« exit » à la fin des commandes, ni de notes après.
Mes scripts sont encore l'exception.
De plus, le présent script ne lit pas les commen-
taires dans le corps même du script, entre le
« #### » et la commande « exit ».
Les résultats seront donc variables. Mais ce script
est sans doute suffisant pour donner un aperçu.
2) Pour vous faciliter la lecture,
2.1) étirez la largeur de la console vers la droite
pour pouvoir lire des lignes de 90 à 100 caractères.
On ne sait jamais !
2.2) étirez aussi la hauteur (ou utilisez la fonction
de votre gestionnaire de fenêtres prévue pour).
2.3) À moins que vous passiez en « plein écran » ?
3) On peut enregistrer les commentaires pour les
lire par la suite en tapant :
lit-commentaires.sh nom-du-script > extrait.
Puis on tape : more extrait
# Fin #Ai-je besoin d'expliquer davantage ?[4;1;33mEn-tête du script :[0m
#!/bin/ash
# /root/my-applications/bin/lit-commentaires.sh
#
# Objectif : extraire les comentaires d'un script
# ------------ pour renseigner l'utilisateur.
#
# Usage : lit-commentaires.sh < nom du script >
#
# Exemple : lit-commentaires.sh lit-commentaires.sh
#
# (c), musher0, 3i janvier 2019. GPL3.
####
[4;1;33mNotes à la fin du script :[0m
exit
Notes :
1) C'est très simple, comme vous le constatez.
Il faut cependant que les dièzes introduisant les
commentaires soient exactement dans la 1ère
colonne, ainsi que le mot « exit ».
Concernant l'en-tête, tous les scripts en ont une.
Mais tous les scripts ne comportent pas la mention
« exit » à la fin des commandes, ni de notes après.
Mes scripts sont encore l'exception.
De plus, le présent script ne lit pas les commen-
taires dans le corps même du script, entre le
« #### » et la commande « exit ».
Les résultats seront donc variables. Mais ce script
est sans doute suffisant pour donner un aperçu.
2) Pour vous faciliter la lecture,
2.1) étirez la largeur de la console vers la droite
pour pouvoir lire des lignes de 90 à 100 caractères.
On ne sait jamais !
2.2) étirez aussi la hauteur (ou utilisez la fonction
de votre gestionnaire de fenêtres prévue pour).
2.3) À moins que vous passiez en « plein écran » ?
3) On peut enregistrer les commentaires pour les
lire par la suite en tapant :
lit-commentaires.sh nom-du-script > extrait.
Puis on tape : more extrait
# Fin #
Commentaires bienvenus.
À+
