Como exporto a documentação do código em C#/VisualStudio 2008?

Question

Sempre fiz questão de escrever bons comentários de código para classes e métodos com a sintaxe xml do C#.Sempre esperei poder exportá-los facilmente mais tarde.

Hoje, na verdade, tenho que fazer isso, mas estou tendo dificuldade em descobrir como.Tem algo que estou perdendo?Eu quero ir Menu->Build->Build Code Documentation, mas não há opção para fazer isso.

Answer 1

Na verdade, está nas propriedades do projeto.Guia Construir, seção Saída, arquivo de documentação XML e insira o nome do arquivo.Ele será construído em cada build do projeto.

Depois disso, você pode construir a ajuda real com Castelo de Areia.

Answer 2

Você poderia tentar NDOC ou Castelo de Areia se você não se importa em usar ferramentas de terceiros.

Answer 3

Castelo de Areia funciona muito bem para gerar documentação e suporta alguns formatos diferentes para geração.Até onde eu sei, não há integração com o Visual Studio para isso, mas há uma Castelo de areiaGUI para isso que está disponível.

Answer 4

Tenha cuidado se estiver usando LINQ to SQL, pois não será possível adicionar facilmente comentários sustentáveis ​​aos objetos gerados automaticamente.

Answer 5

Comentário tardio, mas vale a pena acrescentar que, embora Sandcastle esteja desativado, o Construtor de arquivos de ajuda do Sandcastle permanece em desenvolvimento ativo e achei muito poderoso e simples de mergulhar ao lidar exatamente com essa situação - instale a saída avançada .chm e .html/.asp em algumas horas.

Answer 6

O projeto NDoc original (mencionado por outros) está morto, mas há um novo projeto chamado NDoc3.

NDoc3 suporta .NET 2.0 - 3.5.Atualmente está disponível como uma versão beta e funcionou muito bem para mim.Não tenho certeza se o projeto ainda está ativo – o último beta foi lançado em abril de 2009.