v0.2.12

examples/043-documentation-et-tests-de-conformite-examples.md

@@ -0,0 +1,77 @@
+# Exemples / DO-DON'T — Chapitre 43 — Documentation et tests de conformité
+
+> Document compagnon non normatif tant qu'une règle n'est pas explicitement référencée comme normative par le chapitre.
+
+## Exemples actuellement présents dans le chapitre
+
+### Exemple 1
+
+```text
+README
+sommaire
+un fichier Markdown par chapitre
+un fichier compagnon examples + DO/DON'T par chapitre
+annexes référencées
+manifest de distribution
+```
+
+### Exemple 2
+
+```text
+version cible
+version de base
+fichiers ajoutés
+fichiers modifiés
+fichiers supprimés
+hashes des fichiers livrés
+```
+
+### Exemple 3
+
+```text
+DO
+DON'T
+WHY
+compiler error
+edge cases
+```
+
+### Exemple 4
+
+```text
+// commentaire de ligne
+/* commentaire de bloc */
+```
+
+### Exemple 5
+
+```text
+/// documentation de ligne
+/** documentation de bloc */
+```
+
+### Exemple 6
+
+```text
+@file-path
+@package
+@author
+@created
+@updated
+@file-version
+```
+
+### Exemple 7
+
+```text
+@file-path     chemin documentaire attendu, normalement relatif à la racine du package
+@package       identité/coordonnée du package concerné
+@author        auteur/contributeur associé
+@created       date de création documentaire
+@updated       date ou timestamp de dernière mise à jour documentaire
+@file-version  version propre au fichier, distincte de la version package
+```
+
+## DO / DON'T / WHY / compiler error / edge cases
+
+La couverture structurée de cette section sera enrichie au fur et à mesure de la fermeture des règles du chapitre. La migration `0.2.12` conserve volontairement les exemples historiques dans le chapitre afin de ne perdre aucun contexte normatif.