c#xml代码注释用于文件引用

时间:2011-03-23 10:37:34

标签: c# xml-comments

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

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

4 个答案:

答案 0 :(得分:6)

您可以混合其他命名空间中的元素,包括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

的机器上使用它并没什么用处

答案 1 :(得分:5)

你可以使用文件URI,这使它可以在visual studio中点击:

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

答案 2 :(得分:1)

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

答案 3 :(得分:0)

在XML中存在像文件引用的特殊标记这样的东西。没有这些限制的是元语言。