live documenter
v2.1.53
Não deixe os comentários se esconderem no seu código-fonte! Leia, pesquise e publique com o Live Documenter. Documentação para .NET facilitada.
Live Documenter é um conjunto de aplicativos e bibliotecas que permitem a visualização ao vivo e a geração automática de documentação a partir de código .NET e arquivos de comentários xml. Aprenda o que é o Live Documenter em nossa página inicial e baixe a versão mais recente.
Veja a documentação ao vivo e atualizada!
Crie uma bela documentação estática.
Ou use a biblioteca API para integrar seus próprios projetos.
O Live Documenter é um aplicativo de desktop, utilitário de console e biblioteca de API projetado para tornar seu código .NET e comentários mais legíveis e mais disponíveis. Vamos libertá-los dos limites do xml escondido em seu código-fonte e colocá-los em bom uso!
Comece baixando a versão mais recente e lendo o guia de início rápido.
O aplicativo de desktop permite que projetos, soluções ou bibliotecas do Visual Studio sejam abertos e a documentação gerada para eles a partir dos arquivos de comentários XML ao vivo. Se forem feitas alterações na base de código, elas serão refletidas no aplicativo quando o projeto for reconstruído.
Ele também fornece uma interface agradável para exportar documentação, ler e imprimir.
A aplicação exportadora é útil para integrar a geração de documentação aos processos existentes; como seus scripts de construção ou criação de documentação ad-hoc.
Uma DLL que pode ser referenciada por projetos para gerar documentação automaticamente em tempo de execução. Detalhes da API e como usá-la podem ser encontrados na documentação.
No momento, isso só funcionará no Windows, o trabalho está em andamento para transferir para o netstandard e para tornar tudo, exceto o aplicativo de desktop, multiplataforma no .NET Core.
Um arquivo zip da versão mais recente é fornecido. Para instalar, baixe o arquivo, descompacte e execute nos diretórios.
Requisitos
SDK do .NET Core 3.1
O código mais recente foi trabalhado no Visual Studio 2019 e vários projetos foram transferidos para bibliotecas netstandard e usam o formato de arquivo csproj mais recente.
Por favor, deixe-me saber se há algum problema ao construir a partir da fonte para que eu possa resolvê-lo.
Toda ajuda é apreciada. Existe um site de documentação associado que sempre pode ser melhorado.
Se você gostaria de se envolver no projeto, dê uma olhada nas questões atuais. Anote seu interesse, obtenha a versão mais recente e crie uma solicitação pull quando estiver pronto para mesclar as alterações.
Além disso, simplesmente fornecer feedback por meio de problemas do GitHub ajuda a garantir que o projeto esteja se tornando mais estável e sendo constantemente aprimorado.
