Resultados da pesquisa a pedido "documentation"
Como escrever corretamente referências cruzadas para documentação externa com interesfinge?
Estou tentando adicionar referências cruzadas à API externa na minha documentação, mas estou enfrentando três comportamentos diferentes. Estou usando sphinx (1.3.1) com Python (2.7.3) e meu mapeamento inter-esfinge está configurado como: { ...
Erro ao usar módulos locais em testes de documentação
Estou brincando com uma pequena caixa para geração de ruído 2D. Aqui está um trecho simplificado do meu arquivo "lib.rs": pub mod my_math { pub struct Vec2<T> { ... } ... } pub mod my_noise { use num::Float; use std::num::Wrapping; use ...
Documentos xml do .NET - documentação herdada
NDoc possui um elemento XMLherditdocque permite herdar a documentação de um membro da classe pai (ou de uma interface implementada). No entanto, o Visual Studio (ou seja, o compilador C #) não entende essa marca e reclama da documentação não ...
A cobertura de código 100% é realmente uma coisa boa ao fazer testes de unidade? [fechadas]
Eu sempre aprendi que fazer a cobertura máxima de código com testes de unidade éBoa. Também ouço desenvolvedores de grandes empresas como a Microsoft dizendo que escrevem mais linhas de código de teste do que o próprio código executável. Agora,é ...
O Swagger pode gerar automaticamente seu yaml com base nas rotas expressas existentes?
Eu herdei uma API existente e gostaria de documentá-la com arrogância, mas ainda não conheço o escopo completo dela. O Swagger (ou outro middleware / ferramenta) pode gerar automaticamente o yaml (para o swagger) com base nas rotas ...
A tag Sphinx: ivar procura referências cruzadas
Quero documentar os atributos do objeto Python com o Sphinx. Eu entendo que eu deveria usar :ivar varname: description :ivar type varname: descriptionNo entanto, estou vendo um comportamento estranho, ou seja, o Sphinx procura no meu projeto o ...
XSD para documentação XML gerada para C #? [fechadas]
Alguém sabe se existe algum arquivo XSD em algum lugar que possa ser usado para validar a documentação XML gerada quando você compila um projeto C # com a opção / doc? Quero modificar esse arquivo manualmente depois que ele foi gerado e ...
Como defino o idioma para o site do desenvolvedor do Android? [fechadas]
Quando tento navegar para o site do desenvolvedor do Android, sou redirecionado para uma versão em grande parte em chinês. Por exemplo, se eu tentar navegar para: developer.android.comEu sou redirecionado ...
O Jazzy não está funcionando conforme o esperado para gerar documentação rápida
Depois de fazer algumas pesquisas sobre a melhor maneira de documentar códigos rápidos. Me deparei com o Jazzy e como era simples de implementar. Então eu sigo a seção de instalação doDocumentação jazzística [https://github.com/Realm/jazzy] . eu ...
Páginas de Ajuda da API da Web ASP - Link para classe da tag XML <see>
Estou trabalhando no desenvolvimento de um projeto de API da Web e estou muito impressionado com a documentação gerada automaticamente pelas HelpPages da Microsoft. ativei a documentação personalizada usando o site oficialcriando Páginas ...