Le code dit comment c'est fait.
La doc dit à quoi ça sert et comment l'utiliser
Une bonne doc c'est extrêmement plaisant à utiliser.
Des exemples qui me viennent : jq, sqlpage, jinja, python stdlib.
Une mauvaise doc c'est une doc qui se contente d'énumérer la liste des fonctions avec une description qui paraphrase le nom de la fonction.
J'ai trouvé un peu de ça dans les packages elixir ou python alors que j'adore programmer dans ces langages.
[^] # Re: non, c'est l'inverse
Posté par steph1978 . En réponse au lien Is Documentation Like Pineapple on Pizza?. Évalué à 8. Dernière modification le 18 juin 2025 à 20:52.
Le code dit comment c'est fait.
La doc dit à quoi ça sert et comment l'utiliser
Une bonne doc c'est extrêmement plaisant à utiliser.
Des exemples qui me viennent : jq, sqlpage, jinja, python stdlib.
Une mauvaise doc c'est une doc qui se contente d'énumérer la liste des fonctions avec une description qui paraphrase le nom de la fonction.
J'ai trouvé un peu de ça dans les packages elixir ou python alors que j'adore programmer dans ces langages.