1 repository
Mechanisms for converting structured syntax trees back into their original source text representation.
Distinct from Syntax Tree Transformers: Distinct from general Syntax Tree Transformers by specifically enabling the return path from AST to plain text source code.
Explore 1 awesome GitHub repository matching software engineering & architecture · Bidirectional Transformations. Refine with filters or upvote what's useful.
TSDoc 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.
Converts structured syntax trees back into plain text comments to allow for automated modification of source code.