1 repository
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
Găsește cele mai bune repo-uri cu AI.Vom căuta cele mai potrivite repository-uri folosind AI.
- microsoft/tsdoc
microsoft/tsdoc
4,954Vezi pe GitHubTSDoc este un standard de documentație și o specificație pentru scrierea comentariilor structurate în codul TypeScript. Oferă un sistem portabil pentru definirea metadatelor, etichetelor și referințelor încrucișate în interiorul codului sursă pentru a asigura parsarea și randarea consistentă în diferite instrumente. Proiectul include un parser de comentarii doc care convertește comentariile într-un arbore de sintaxă structurat și un validator care impune consistența sintaxei. Permite definirea de etichete de documentație personalizate prin fișiere de configurare externe și suportă moduri multiple de validare a sintaxei pentru a asista la conformitatea cu specificațiile. Specificația acoperă o gamă largă de nevoi de documentare API, inclusiv marcarea etapelor de lansare, stabilitatea și deprecierea. Suportă detalierea parametrilor funcțiilor, valorilor returnate și tipurilor de excepții, precum și gestionarea vizibilității interne, moștenirii și referințelor încrucișate între declarații.
Provides a standard way to specify the default value for a member in the documentation.
TypeScriptcommentsdoc-commentsdocumentation
