Comentário de código c # xml para referência de arquivo

Question

Existe uma tag para uma referência de arquivo em um comentário de código xml?O arquivo é um arquivo de script sql. Apenas me perguntando se há uma maneira melhor do que algo assim

///<summary>
///please have a look at c:\code\project1\sql\file1.sql
///</summary> 

Answer 1

Você pode usar um URI de arquivo, o que o torna clicável no Visual Studio:

file:///c:/code/project1/sql/file1.sql

Answer 2

Você pode misturar elementos de outros namespaces, incluindo xhtml, então

///<summary>
///please have a look at <a href="file:///c:/code/project1/sql/file1.sql">file:///c:/code/project1/sql/file1.sql</a>.
///</summary>

É permitido, mas se será bem usado ou não depende do que você usa para transformar o XML em algo mais legível.O uso da dica de ferramenta pelo menos em meu IDE ignora a tag e exibe o texto dentro (que é o que eu gostaria de uma dica de ferramenta).

Claro, não é muito útil em uma máquina que não tem o c: \ code \ project1 \ sql \ file1.sql correto

Answer 3

As tags mais comumente usadas estão listadas em http://msdn.microsoft.com/en-us/library/5ast78ax (v= vs.71) .aspx .Ele também menciona que irá processar "qualquer tag que seja XML válido", então você não está limitado a eles.

Answer 4

Existem coisas como uma tag especial para referência de arquivo em XML.É uma meta linguagem sem tais limitações.