1 dépôt
Awesome GitHub RepositoriesDocumentation Default Values
Tags used to explicitly document the default values of API members.
Distinct from Schema Default Values: Distinct from Schema Default Values: focuses on the documentation of the value rather than the runtime assignment.
Explore 1 awesome GitHub repository matching software engineering & architecture · Documentation Default Values. Refine with filters or upvote what's useful.
Awesome Documentation Default Values GitHub Repositories
Trouvez les meilleurs dépôts grâce à l'IA.Nous recherchons les dépôts les plus pertinents grâce à l'IA.
- microsoft/tsdoc
microsoft/tsdoc
4,954Voir sur GitHubTSDoc est un standard de documentation et une spécification pour l'écriture de commentaires structurés dans le code TypeScript. Il fournit un système portable pour définir des métadonnées, des balises et des références croisées au sein du code source afin d'assurer une analyse et un rendu cohérents à travers différents outils. Le projet inclut un analyseur de commentaires de documentation qui convertit les commentaires en un arbre de syntaxe structuré et un validateur qui applique la cohérence syntaxique. Il permet la définition de balises de documentation personnalisées via des fichiers de configuration externes et prend en charge plusieurs modes de validation de syntaxe pour aider à la conformité aux spécifications. La spécification couvre un large éventail de besoins en documentation d'API, y compris le marquage des étapes de publication, la stabilité et la dépréciation. Elle prend en charge le détail des paramètres de fonction, les valeurs de retour et les types d'exception, ainsi que la gestion de la visibilité interne, de l'héritage et des références croisées entre les déclarations.
Provides a standard way to specify the default value for a member in the documentation.
TypeScriptcommentsdoc-commentsdocumentation
