c# - c# xml代码注释供文件参考

Question

xml 代码注释中是否有文件引用标签？该文件是一个 sql 脚本文件。只是想知道是否有比这样更好的方法

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

Answer 1

您可以使用文件 URI，这使得它可以在 Visual Studio 中单击：

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

Answer 2

您可以混合来自其他命名空间的元素，包括 xhtml，所以

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

是允许的，但它是否被很好地利用取决于您使用什么来将 XML 转换为更具可读性的东西。至少在我的 IDE 中使用工具提示会忽略标记并在其中显示文本（这是我在工具提示中想要的）。

当然，在没有正确 c:\code\project1\sql\file1.sql 的机器上用处不大

Answer 3

最常用的标签在http://msdn.microsoft.com/en-us/library/5ast78ax(v=vs.71).aspx中列出。它还提到它将处理“任何有效 XML 的标签”，因此您不限于这些。

Answer 4

XML中有文件引用的特殊标记之类的东西。它是没有这些限制的元语言。