Gerar um arquivo de ajuda Sandcastle para um site sem a opção “XML Documentation File”

Question

Eu estou tentando gerar um arquivo de ajuda Sandcastle de um site. Na janela de propriedades para o projeto, não existem quaisquer opções para criar o arquivo de documentação XML necessário para Sandcastle.

O guia Construir nas páginas de propriedade única contém opções para: Iniciar Ação, Criar solução Ação, e validação de acessibilidade. Eu não tenho quaisquer opções de saída, ou arquivo de documentação XML, como meus outros projetos têm.

O site que eu estou trabalhando com não tem um arquivo de proj real, que poderia ser o problema. Se este for o problema, o que é a melhor maneira de criar um para um projeto que está sob controle de origem e sendo trabalhado por muitas pessoas com o mínimo de interrupção?

Esta é usando o Visual Studio 2005 Professional.

Answer 1

O problema com sites em VS2k5 é que, quando eles se compilado, as DLLs resultantes são uma bagunça. Não namespaces, nomes estranhos, etc.

Se você realmente deseja gerar um arquivo Sandcastle Ajuda, olhar para converter seu site em um aplicativo web. Você pode definitivamente gerar docs de código fonte para isso.

Answer 2

Eu não tentei ainda, mas você pode querer tentar o seguinte Documentação Web Sites / Projectos do site do Eric Woodruff . Ele dá os detalhes sobre como isso pode ser feito.

Update: Eu tentei e ele funciona para sites regulares. O único problema que vejo é que os sites não têm namespaces. Então, quando eu executá-lo eu recebo um tópico formato FolderName_WebPage Classe sem qualquer agrupamento lógico. Por isso, é alhpabetical por pasta e nome da página. Uma vez que você tem o conteúdo criado, você pode editar o arquivo de ajuda usando um helpcompiler / construtor e agrupar os tópicos como necessário.