C # Commentaire du code XML pour la référence du fichier

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

  •  28-10-2019
  •  | 
  •  

Question

Existe-t-il une balise pour une référence de fichier dans un commentaire de code XML? Le fichier est un fichier de script SQL. Je me demande juste s'il y a une meilleure façon que quelque chose comme ça

///<summary>
///please have a look at c:\code\project1\sql\file1.sql
///</summary>
Était-ce utile?

La solution

Vous pouvez utiliser un fichier URI, cela le rend cliquable dans Visual Studio:

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

Autres conseils

Vous pouvez mélanger des éléments d'autres espaces de noms, y compris XHTML, donc

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

Est autorisé, bien qu'il soit utilisé bien ou non dépend de ce que vous utilisez pour transformer le XML en quelque chose de plus lisible. L'utilisation d'infraction au moins dans mon IDE ignore la balise et affiche le texte à l'intérieur (c'est ce que je voudrais dans un outil).

Bien sûr, il n'est pas très utile sur une machine qui n'a pas le bon C: Code Project1 SQL File1.Sql

Les balises les plus couramment utilisées sont répertoriées à http://msdn.microsoft.com/en-us/library/5ast78ax(v=vs.71).aspx. Il mentionne également qu'il traitera "n'importe quelle balise qui est valide XML", vous n'êtes donc pas limité à ceux-ci.

Il existe des choses comme une balise spéciale pour la référence de fichiers dans XML. C'est une langue méta sans telles limitations.

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top