Comentário .Net XML na documentação da API

Question

Existe uma maneira fácil de produzir documentação no estilo MSDN a partir da saída XML do Visual Studio?
Não tenho paciência suficiente para montar um bom xslt porque sei que não sou a primeira pessoa a cruzar esta ponte.

Além disso, tentei montar um castelo de areia recentemente, mas isso realmente fez meus olhos se cruzarem.Ou estava faltando algo importante no processo ou ele estava muito complicado.

Eu sei que alguém lá fora tem uma solução muito boa e simples.

Estou reiterando aqui porque acho que minha formatação tornou esse parágrafo pouco convidativo para leitura:

Experimentei o castelo de areia, mas tive muita dificuldade em configurá-lo.O que realmente tenho em mente é algo muito mais simples.

Isto é, a menos que eu simplesmente não entenda o processo do castelo de areia.Parecia uma enorme bagagem extra para mim apenas produzir algo legal para os testadores trabalharem.

Answer 1

Você está procurando por Castelo de Areia

Página do projeto: Lançamentos de castelo de areia

Blogue: Blog do Castelo de Areia

Gerador de documentação de código NDoc para .NET costumava ser a ferramenta preferida, mas o suporte praticamente parou.

Answer 2

Dê uma olhada em Castelo de Areia, que faz exatamente isso.É também uma das soluções mais simples que existem e é mais ou menos a ferramenta preferida. Portanto, a longo prazo, talvez possamos ajudá-lo a configurar o Sandcastle se você especificar quais problemas encontrou durante a configuração.

Answer 3

Você também deve usar o Sandcastle Help File Builder.Ele fornece uma GUI semelhante a um ndoc para gerar arquivos de ajuda, para que você não precise fazer nada em um prompt de comando.

Bem-vindo ao projeto Sandcastle Help File Builder

Answer 4

Seguir este artigo simples de 5 etapas e você está praticamente pronto.Como bônus você pode usar H2Viewer para visualizar arquivos HTML Help 2.x.

Answer 5

Acabei de configurar o Sandcastle novamente.Tente instalá-lo (versão de maio de 2008) e procure SandcastleGui.exe ou algo semelhante (está na pasta de exemplos ou algo assim).

Clique em Adicionar Assembly e adicione seu Assembly ou Assemblies, adicione quaisquer arquivos de documentação .xml (aqueles gerados pelo compilador se você habilitou essa opção) e, em seguida, Build.

Levará algum tempo, mas o resultado vai valer a pena o esforço.Na verdade, ele procurará coisas no MSDN, portanto, sua documentação resultante também terá a herança de classe até System.Object com links para o MSDN e outras coisas.

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

Dê uma olhada também Construtor de arquivos de ajuda do Sandcastle, esta é uma GUI um pouco mais avançada para isso.

Answer 6

eu uso NDoc3