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

谢谢。是否可以有相对路径？file://..\..\..\file.sql 这似乎不起作用 (2认同)
- 遗憾的是，这不起作用，我尝试了/// file:../../Database/EmployeeUploadFileConfiguration_TestDataForFormulaValidation.sql，甚至通过引用同一文件夹中的另一个文件进行了测试：/// file://EligibilityCriteriaFormulaTests。 cs 耻辱，因为这对评论非常有帮助。智能感知链接不起作用 (2认同)

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的机器上使用它并不多.