2011-03-23 81 views
4

在xml代码注释中是否有文件引用的标签?该文件是一个sql脚本文件。 只是不知道是否有比这样的c#xml代码注释文件参考

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

您是否使用这些xml注释来生成sandcastle或其他内容的html帮助文件? – dvdvorle 2011-03-23 10:49:38

回答

4

你可以使用一个文件URI,这使得它在Visual Studio中点击:

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

谢谢。有可能有一个相对路径? file:// .. \ .. \ .. \ file.sql 这似乎不起作用 – JML 2011-03-23 11:23:00

+0

@JML - 是的,那会是(假设你的文件是“c:\ code \ project \ code \ source”。 cs“)”file:../ sql/file1.sql“ – dvdvorle 2011-03-23 11:56:04

+1

- 不幸的是,这是行不通的,我试过///文件:../../ Database/EmployeeUploadFileConfiguration_TestDataForFormulaValidation.sql,甚至用引用来测试另一个文件在同一个文件夹中:/// file://EligibilityCriteriaFormulaTests.cs惭愧,因为这对于评论非常有帮助。 intellisense链接不起作用 – JML 2011-03-23 14:50:53

0

有没有像在XML文件中引用的特殊标签这样的事情更好的方法。它是没有这种限制的元语言。

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:\代码\ PROJECT1 \ SQL \ file1.sql