Para quem estava sentindo falta de uma versão do NDoc para Visual Studio 2005 a Microsoft acaba de lançar o CTP de seu próprio gerador de documentação chamado Sandcastle. Com ele você poderá gerar documentação semelhante ao MSDN.
Documentando seu código com VB .NET
A documentação em VB.NET deve ser escrita no código na forma de comentários iniciados com três apóstrofos isso quase sempre fará com que o VS gere blocos XML com os seguintes tipos de comentário:
''' <summary>
''' Descrição do método.
''' </summary>
''' <param name="paramName">Descrição do parâmetro</param>
''' <value>Descreve uma propriedade</value>
''' <returns>Retorno da função</returns>
''' <remarks>Informações complementares</remarks>
OBS.: Para uma lista detalhada de todas as opções em português consulte o MSDN Wiki Beta ou a ajuda do VS2005.
Devemos então verificar se a opção “Generate XML documentation file” esta marcada no Visual Studio 2005.
Menu - Project / Properties / Compile / |X| Generate XML documentation file
Fazendo isso ao compilarmos o projeto o Visual Studio não só ira gerar o assembly (exe / dll) do, mas também ira gerar um arquivo XML com os comentários.
Gerando a documentação com o Sandcastle
Devemos neste momento instalar o Sandcastle, porem como este é um CTP que ainda não possui integração total com o Visual Studio, vamos instalar tambem outros dois programas. Um programa chamado “HTML Help Workshop” que será responsável por criar os arquivos CHM e o outro chamado “Sandcastle Help File Builder” uma GUI para nos ajudar com as configurações.
Configurando o Sandcastle com o “Sandcastle Help File Builder”
Ao abrir o programa este nos apresenta uma serie de opções as mais importantes estão na sessão Help File e Paths e devem ser configuradas da seguinte maneira:
Help File
SdkLinkType: None. – A opção MSDN faz uma consulta online a este que pode demorar muito
Paths
HtmlHelp1xCompilerPath: C:\Arquivos de programas\HTML Help Workshop\
OutPutPath: <Configure a pasta onde o arquivo será gerado>
SandcastlePath: C:\Arquivos de programas\Sandcastle\
Gerando a documentação
Clique no botão Add e escolha a opção arquivos do tipo “XML Comment Files” localize o arquivo XML com comentários (normalmente na mesma pasta em que o executável foi gerado)
Salve seu projeto de documentação na mesma pasta onde a documentação será gerada.
Clique no botão namespace e desmarque o que você não tem interesse em documentar.
Clique no botão "Build Help File" e aguarde a documentação ser gerada.
Downloads
Sandcastle August 2006 CTP
Html Help Workshop 1.3
Sandcastle Help File Builder
Ate +