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

【问题标题】：c# xml code comment for file referencec# xml代码注释供文件参考
【发布时间】：2011-03-23 10:37:34
【问题描述】：

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

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

【问题讨论】：

【解决方案1】：

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

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

【讨论】：

谢谢。有可能有相对路径吗？ file://..\..\..\file.sql 好像不行
@JML - 是的，那将是（假设您的文件是“c:\code\project\code\source.cs”）“file:../sql/file1.sql”跨度>
- 遗憾的是，这行不通，我尝试过 /// file:../../Database/EmployeeUploadFileConfiguration_TestDataForFormulaValidation.sql 甚至参考同一文件夹中的另一个文件进行了测试：/ // file://EligibilityCriteriaFormulaTests.cs 很遗憾，因为这对 cmets 很有帮助。智能感知链接不起作用
哦，对不起，它似乎与 devenv.exe（Visual Studio 可执行文件）位置有关。我不确定我是怎么错过的：-s。所以它只适用于绝对路径。

【解决方案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 的机器上用处不大

【讨论】：

【解决方案3】：

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

【讨论】：

【解决方案4】：

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

【讨论】：