API Extractor

API Extractor

O API Extractor ajuda a escrever melhores bibliotecas TypeScript: analisa suas assinaturas de tipo exportadas e (1) produz um site de documentação da API, (2) gera um arquivo "rollup" .d.ts e (3) cria um relatório da API para facilitar o PRavaliações.
O Extrator de API ajuda os desenvolvedores de TypeScript a gerenciar a superfície da API para sua biblioteca.É distribuído como um pacote NPM "@ microsoft / api-extractor".Ele produz três tipos diferentes de saída: - Relatório da API - O API Extractor pode rastrear todas as exportações do ponto de entrada principal do seu projeto e gerar um relatório para ser usado como base para um fluxo de trabalho de revisão da API.- Rollups .d.ts - Similar ao modo como o Webpack pode "reunir" todos os seus arquivos JavaScript em um único pacote para distribuição, o API Extractor pode reunir suas declarações TypeScript em um único arquivo .d.ts.Esse arquivo pode ser aparado para excluir declarações marcadas usando tags TSDoc, como @beta "ou @internal. - Documentação da API - A ferramenta gera um arquivo JSON" modelo de documento "para cada um de seus projetos. Esse arquivo JSON contém as assinaturas de tipo extraídas eA ferramenta complementar "api-documenter" pode usar esses arquivos para gerar um site de referência da API ou você pode usá-los como entradas para um pipeline de documentação personalizado.
api-extractor

Local na rede Internet:

Recursos

Categorias

Alternativas ao API Extractor para todas as plataformas com qualquer licença

Compodoc

Compodoc

Compodoc é uma ferramenta de documentação para aplicações angulares.Ele gera uma documentação estática do seu aplicativo.
ESDoc

ESDoc

Um bom gerador de documentação para JavaScript.
TypeDoc

TypeDoc

Um gerador de documentação para projetos TypeScript.
Docma

Docma

O Docma é uma ferramenta poderosa para gerar facilmente uma bela documentação HTML a partir de arquivos Javascript (JSDoc), Markdown e HTML.
Dgeni

Dgeni

dgeni - gerador de documentação JavaScript flexível usado pelo AngularJS, transferidor e outros projetos JS
Smartcar

Smartcar

Na Smartcar, capacitamos os desenvolvedores a construir o futuro da mobilidade.