Gerando arquivos de documentação no Visual Studio 2005
Depois de finalizar um projeto no VS 2005 achei que gerar a documentação dele seria um simples clique sobre uma das opções do menu e ponto final.
Nada disso. Nem no VS 2003 e muito menos no 2005 as coisas são tão simples. No 2003 usa-se o NDoc, e se você quer gerar pra VB ainda precisará de alguns passos a mais, conforme descrito pelo Israel Aéce.
Para o VS 2005 já não é mais possível utilizar o NDoc, pois ele foi descontiuado e não suporta dlls e executáveis compilados para o .NET 2.0. A solução, neste caso, é utilizar Sandcastle juntamente com o Sandcastle help file builder. O primeiro é uma ferramenta que via linha de comando gera os arquivos de documentação. Já o segundo é uma interface gráfica para esta ferramenta que torna o trabalho muito mais fácil. O Ramon Durães publicou um ótimo artigo sobre o assunto no site Linha de Código.
Seguindo rigorosamente os passos que ele descreveu no artigo, dei de cara com o seguinte erro:
Error: Unresolved assembly reference: Microsoft.WindowsMobile.DirectX (Microsoft.WindowsMobile.DirectX, Version=2.0.0.0, Culture=neutral, PublicKeyToken=969db8053d3322ac) required by ThreeDV
Last step completed in 00:00:03.6719
BUILD FAILED: Unexpected error in last build step. See output above for details.
Isso aconteceu pois o Sandcastle não conseguiu resolver algumas dependências (referências) do meu projeto. Em outras palavras, ele não conseguiu encontrar algumas dlls que estavam referenciadas, pois, acredito eu, elas não estavam no Global Assembly Cache (GAC). Logo, se você possui outras dlls (sejam elas de terceiros ou class libraries que você mesmo criou) provavelmente o mesmo erro ocorrerá.
Para resolver este problema você deve informar ao Sandcastle onde estão essas dlls. No meu caso foi simples. Fui até o Visual Studio e na lista de referências obtive o local exato de todas as dlls que provavelmente ele não estava encontrando. Veja:
Dlls não encontradas pelo Sandcastle
Local exato de uma determinada referência / dll
Depois disso, bastou verificar nas propriedades de cada uma (botão direito / propriedades) a localização e copiá-las para uma pasta qualquer (eu copiei para o mesmo diretório do executável que pretendia gerar a documentação).
Feito isto, no Sandcastle help file builder escolha a opção Dependencies e adicione o diretório onde você copiou as dlls. Veja:
Dependências do projeto
Adicionando uma dependência ao projeto
Pronto. Agora basta gerar a documentação através do menu Documentation / Build Project. Não estranhe se demorar, pois aqui levou mais de 5 minutos.
Até +.
Deixe o seu comentário