Existe-t-il une norme standard que les gens utilisent pour documenter leurs bibliothèques et leurs frameworks?Quel est l'équivalent de swagger pour sdk?
Idéalement, il utiliserait JSON ou YAML et permettrait la génération de pages HTML qui le présentent bien.
L'approche la plus courante de la documentation SDK consiste à générer les documents à partir des commentaires du code source. De cette façon, les documents de référence de classe/fonction peuvent être facilement synchronisés avec l'implémentation.
Il existe des générateurs de documentation pour différents langages de programmation et frameworks. Certains outils vous permettent de combiner les documents de référence générés avec des sujets conceptuels saisis manuellement (vue d'ensemble, "mise en route", etc.)
Certains outils populaires sont:
connexes: [? Quels sont les outils utilisés pour écrire la documentation] (https://stackoverflow.com/ q/12537/113116), [Quelle est la meilleure façon de stocker la documentation du logiciel?] (https://stackoverflow.com/q/99419/113116) – Helen