Comentário XML .Net em Documentação da API

votos
15

Existe uma maneira fácil de produzir documentação MSDN-estilo da saída XML Visual Studio?
Eu não estou doente o suficiente para configurar uma boa xslt para ele, porque eu sei que não sou a primeira pessoa a atravessar esta ponte.

Além disso, eu tentei configurar castelo de areia recentemente, mas realmente fez meus olhos cruz. Ou eu estava faltando alguma coisa importante no processo ou é apenas uma maneira muito envolvido.

Eu sei que alguém lá fora, tem uma solução mortos-simples muito bom.

Eu estou reiterando aqui porque eu acho que a minha formatação feita que não convidativo parágrafo para ler:

Eu dei Sandcastle uma tentativa, mas teve um momento muito difícil consegui-lo configurar. O que eu realmente tenho em mente é algo muito mais simples.

Isto é, a menos que eu só não entendo o processo de castelo de areia. Parecia uma enorme quantidade de bagagem extra para mim apenas para produzir algo de bom para os testadores para trabalhar.

Publicado 03/08/2008 em 23:03
fonte usuário
Em outras línguas...                            


6 respostas

votos
9

Você está procurando Sandcastle

Projeto Página: Lançamentos Sandcastle

Blog: Blog Sandcastle

NDoc Gerador de Documentação do Código for .NET costumava ser a ferramenta de escolha, mas o apoio tem tudo, mas parou.

Respondeu 03/08/2008 em 23:12
fonte usuário

votos
5

Você também deve usar o Sandcastle Builder Help File. Ele lhe proporciona um ndoc como GUI para gerar arquivos de ajuda para que você não tem que fazer nada a partir de um prompt de comando.

Bem-vindo ao Project Builder arquivo de ajuda Sandcastle

Respondeu 19/09/2008 em 16:22
fonte usuário

votos
5

Ter um olhar para Sandcastle , que faz exatamente isso. É também uma das soluções mais simples lá fora, e é mais ou menos a ferramenta de escolha, por isso, a longo prazo, talvez possamos ajudá-lo a configurar Sandcastle se especificar quais as questões que você encontrou durante a instalação?

Respondeu 03/08/2008 em 23:14
fonte usuário

votos
3

Siga este artigo simples de 5 etapas e você está muito bem feito. Como um bônus, você pode usar H2Viewer para exibir arquivos 2.x HTML Help.

Respondeu 04/08/2008 em 11:31
fonte usuário

votos
3

Acabei de configurar Sandcastle novamente. Tente instalá-lo (a versão de maio de 2008) e procurar SandcastleGui.exe ou algo similar (é na pasta exemplos mais ou menos).

Clique em Adicionar Assembléia e adicionar sua Assembleia ou Assembléias, adicione quaisquer arquivos de documentação XML (aqueles gerados pelo compilador se você habilitado essa opção) e, em seguida, construir.

Vai levar algum tempo, mas o resultado vai valer a pena o esforço. Ele vai realmente olhar para cima coisas do MSDN, assim que sua documentação resultante também terá a herança Classe todo o caminho até System.Object com links para MSDN e outras coisas.

Sandcastle parece um pouco complicado no início, especialmente quando você quiser usá-lo em uma compilação automatizada, mas tenho absoluta certeza de que vai valer a pena o esforço.

Também dê uma olhada no Sandcastle Builder Help File , este é um GUI pouco mais avançado para ele.

Respondeu 04/08/2008 em 11:27
fonte usuário

votos
2

Eu uso NDoc3

Respondeu 21/02/2010 em 23:12
fonte usuário

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more