API Extractor

API Extractor

API Extractor vam pomaga pisati boljše knjižnice TypeScript: analizira izvožene podpise vrste in (1) izdela spletno mesto z dokumentacijo API-ja, (2) ustvari datoteko .d.ts "rollup" in (3) ustvari poročilo API-ja za olajšanje PRpregledi.
API Extractor pomaga razvijalcem TypeScript upravljati površino API-ja za svojo knjižnico.Razdeljen je kot paket NPM "@ microsoft / api-extractor".Proizvaja tri različne vrste izhodnih podatkov: - API Poročilo - API Extractor lahko sledi vsem izvozom iz glavne vhodne točke vašega projekta in ustvari poročilo, ki se uporabi kot osnova za delovni potek pregleda v API-ju.- .d.ts Zbirke - Podobno kot Webpack lahko "zviša" vse vaše datoteke JavaScript v enem paketu za distribucijo, lahko API Extractor zvrsti vaše izjave TypeScript v eno datoteko .d.ts.To datoteko je mogoče obrezati tako, da izključi deklaracije, označene z oznakami TSDoc, kot sta @beta "ali @internal. - Dokumentacija API - Orodje ustvari datoteko JSON" doc model "za ta projekt. Ta datoteka JSON vsebuje izvlečene vrste podpisov indoc pripombe. Orodje za spremljevalno orodje "api-documententer" lahko te datoteke uporabi za izdelavo referenčnega spletnega mesta API ali pa jih uporabite kot vhode za cevovod za dokumentacijo po meri.

Lastnosti

Kategorije

Alternativa API Extractoru za Windows

ESDoc

ESDoc

Dober generator dokumentacije za JavaScript. Značilnosti: - Merjenje pokritosti dokumentacije - Kovček dokumentacije - Integracija preskusnih kod v dokumentacijo.
Docma

Docma

Docma je močno orodje za enostavno ustvarjanje čudovite dokumentacije HTML iz datotek Javascript (JSDoc), Markdown in HTML.
Smartcar

Smartcar

V Smartcarju razvijamo pooblaščence za razvoj prihodnosti mobilnosti.