Le SCML, pour " Structured Commentary Markup Language", décliné Structured Changelog Markup Language, Structured CommitMarkup Language, Structured Changes Markup Language, est un langage de balisage.
Il permet l'organisation des commentaires, des changelogs ou des commits de façon structurée et claire.
Le SCML peut être utilisé de plusieurs manières :
Syntaxe
Il existe 7 catégories de balises :
+, * pour un Ajout
/, @ et $ pour une Altération
- et µ pour une Suppression
&, ! et ? pour une Attente
$ et £ pour une Actualisation
< et > pour une Action
:: et /* */ pour un Commentaire
<#scml
::v0.0.0 - Titre
+ Ajout : bleu;
::Exemple : Ajout d’un paragraphe
* Création : bleu;
::Exemple : Création d’un nouveau formulaire
- Suppresion : rouge;
::Exemple : Suppression d’une ligne
µ Orthographe : rouge;
::Exemple : Correction d’une faute
/ Modification : vert;
::Exemple : Modification de l’ergonomie
@ Changement de destination : vert;
::Exemple : Le fichier X se trouve désormais dans le dossier Y
§ Réparation : vert;
::Exemple : Corrections de bugs mineurs
& Ambiguë : rose;
::Exemple : Problème de réalisation, élément à revoir
! Attention particulière : rose;
::Exemple : Risque de faille
? Interrogation: rose;
::Exemple : Interrogation sur d’éventuelles améliorations
$ Mise à jour : orange;
::Exemple : Mise à jour des informations
£ Normalisation : orange;
::Exemple : Nouvelle norme mise en application
> Action interne : mauve;
::Exemple : Action du technicien sur un poste utilisateur ou un serveur
< Action externe : mauve;
::Exemple : Action d'un client, utilisateur, ou prestataire, sur un poste utilisateur ou un serveur
::commentaire sur une ligne : bleu clair
/*
commentaire, sur plusieurs lignes : bleu clair
*/
#>