Pergunta

Eu tenho uma documentação baseada em XML muito completo assembly que contém, que é usado através Sandcastle para gerar os arquivos de ajuda para o produto. Nós também usamos os arquivos XML de saída para fornecer Intellisense adequada no Visual Studio quando os programadores usam a montagem obviamente.

A fim de fazer isso, parece que temos fazer tanto a oferta ao usuário com o conjunto ( "assembly.dll") ea documentação ( "assembly.xml").

É de alguma forma possível incorporar a documentação dentro do conjunto, de modo que só teria que fornecer o conjunto de arquivo único e Visual Studio seria capaz de extrair as informações? Talvez incorporado como um recurso ou algo parecido?

Foi útil?

Solução

Infelizmente, você precisará fornecer tanto como Visual Studio só sabe olhar para os documentos XML para Intellisense.

Outras dicas

Se você procurar C: \ Windows \ Microsoft.NET \ Framework \ v2.0.50727 você vai achar que todos os conjuntos .NET que você pode fazer referência, em seus aplicativos estão usando os arquivos XML. visual studio só irá fornecer intellisense para os conjuntos se existe o arquivo xml. Por exemplo, se você fosse para fechar Visual Studio, em seguida, remover o arquivo System.Drawing.xml e reabra VS, não deve haver qualquer intellisense para essa montagem. Você, então, precisa fechar VS, copiá-lo de volta, e em seguida, reabrir VS para o intellisense para trabalhar novamente.

Estou faltando alguma coisa? Eu sempre comentam como de costume (usando 3 barras ou 3 marcas de escala (VB)), usar o construída em tags XML e quando eu uso a montagem i obter o intellisense - Eu raramente usar um arquivo xml extrernal.

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top