DocumentationDémarrer avec la documentation

Versions

Version Date de sortie
Bêta privée 2016-03-26
1 2016-07-25
2 2016-08-04
3 2016-08-29
4 2016-09-12
5 2016-09-29
6 2016-10-20
7 2016-11-29

À propos de la documentation

Que peut-on documenter?

  • Exemples de fonctions pour différentes langues.
  • Une brève introduction de chaque tag.

Quelle est la différence entre une question et un sujet?

  • Les sujets ont une portée plus large que les questions; Les sujets de documentation qui sont posés en tant que question peuvent être fermés car ils sont trop larges.
  • Les sujets doivent avoir plusieurs exemples; une demande pouvant être traitée par un sujet avec un seul exemple (par exemple, un bloc de code) est probablement trop étroite.

Bonjour le monde

Un thème du monde de bonjour devrait comprendre le programme de base le plus élémentaire, complet, exécutable et disponible, qui peut être réalisé avec le plus grand nombre de versions du langage, du cadre ou du système documenté. Si nécessaire, les remarques doivent inclure des instructions de base sur la préparation et l’exécution des exemples.

Le sujet ne devrait généralement pas nécessiter plus d'un ou deux exemples, sauf dans les cas où les versions ultérieures de la langue ne sont pas rétrocompatibles. Rappelez-vous que le thème du salut sera le point de départ de toute personne qui commence à apprendre une langue. En tant que tel, il devrait démontrer des exemples de travail minimum qu'un apprenant peut utiliser pour réaliser un programme correct. Ce n'est pas nécessairement un endroit pour démontrer les nouvelles fonctionnalités d'une langue.