c # xml-Codekommentar als Dateireferenz

StackOverflow https://stackoverflow.com/questions/5403932

  •  28-10-2019
  •  | 
  •  

Frage

Gibt es ein Tag für eine Dateireferenz in einem XML-Codekommentar?Die Datei ist eine SQL-Skriptdatei. Ich frage mich nur, ob es einen besseren Weg gibt als so etwas 

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

War es hilfreich?

Lösung

Sie können einen Datei-URI verwenden. Dadurch kann er in Visual Studio angeklickt werden: 

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

Andere Tipps

Sie können Elemente aus anderen Namespaces, einschließlich xhtml, einmischen, also 

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

Ist zulässig. Ob es jedoch gut genutzt wird oder nicht, hängt davon ab, was Sie verwenden, um das XML in etwas Lesbareres zu verwandeln.Die Verwendung von QuickInfos zumindest in meiner IDE ignoriert das Tag und zeigt den darin enthaltenen Text an (was ich in einem Tooltip wünschen würde).

Natürlich ist es auf einem Computer, der nicht das richtige c: \ code \ project1 \ sql \ file1.sql hat, nicht sehr nützlich

Die am häufigsten verwendeten Tags finden Sie unter http://msdn.microsoft.com/en-us/library/5ast78ax (v= vs.71) .aspx .Es wird auch erwähnt, dass "jedes Tag, das gültiges XML ist" verarbeitet wird, damit Sie nicht auf diese beschränkt sind.

Es gibt so etwas wie ein spezielles Tag für die Dateireferenz in XML.Es ist eine Metasprache ohne solche Einschränkungen.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top