3 repository-uri
Awesome GitHub RepositoriesDocumentation Inheritance
Mechanisms for automatically propagating documentation from parent definitions to child implementations.
Distinct from Documentation Generators: Distinct from Documentation Generators: focuses on the inheritance logic of documentation content rather than the generation process.
Explore 3 awesome GitHub repositories matching development tools & productivity · Documentation Inheritance. Refine with filters or upvote what's useful.
Awesome Documentation Inheritance GitHub Repositories
Găsește cele mai bune repo-uri cu AI.Vom căuta cele mai potrivite repository-uri folosind AI.
- crystal-lang/crystal
crystal-lang/crystal
20,299Vezi pe GitHubCrystal is a statically typed, compiled programming language designed for high performance and memory safety. It leverages an LLVM-based compiler to translate source code into optimized machine-executable binaries, while its type-inference-based static analysis enforces strict safety rules during the build process. The language distinguishes itself through a fiber-based concurrent runtime that manages lightweight execution units for asynchronous input and output without blocking the main process. It also features a powerful compile-time macro system that allows for the inspection and transfor
Crystal copies documentation from a preceding feature definition to subsequent ones to avoid duplicating identical descriptions.
Crystalcompilercrystalcrystal-language - 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.
Implements logic for automatically propagating documentation from parent definitions to child implementations.
TypeScriptcommentsdoc-commentsdocumentation - phpdocumentor/phpdocumentor
phpDocumentor/phpDocumentor
4,332Vezi pe GitHubphpDocumentor este un generator de documentație API PHP și un analizor de cod sursă care transformă fișierele PHP și DocBlock-urile în referințe API HTML structurate. Funcționează ca un generator de site-uri statice și un instrument de documentare automată conceput pentru a sincroniza documentația tehnică cu modificările de cod. Proiectul se distinge prin faptul că acționează ca un generator de diagrame UML, producând grafice de clasă și arhitecturale prin PlantUML pe baza analizei sursei. De asemenea, suportă scrierea manualelor tehnice, randând ghiduri scrise manual în Markdown și ReStructuredText alături de referințele API generate automat. Instrumentul oferă capabilități largi pentru analiza codului sursă, inclusiv generarea de arbori de sintaxă abstractă, etichetarea metadatelor și gestionarea moștenirii documentației. Include instrumente de vizualizare pentru arhitectura codului, controlul vizibilității elementelor și gestionarea documentației versionate. Build-urile pot fi gestionate prin fișiere de configurare XML pentru a automatiza generarea în cadrul pipeline-urilor de integrare continuă.
Automatically propagates summaries and metadata tags from superclasses or interfaces to child elements.
PHPdocblockdocblocksgraphviz
