沙堡可以从外部文件而不是标题注释中读取XmlDoc吗?

时间:2012-09-17 16:05:33

标签: .net documentation sandcastle

Sandcastle Help File Builder (SHFB)将三次斜线评论转变为文档,如下:

///<summary>A class called Bob</summmary>
public sealed class Bob {}

文档的架构非常强大。但是,文档越健壮,越冗长,有些人会发现实际浏览和编辑源代码就越烦人。一个好的妥协就能做到像

这样的事情
///<summary>A class called Bob</summmary>
///<include href="projectDocs.xml" xpath="/Company/Product/Bob" />
public sealed class Bob {}

这样的事情可能吗?

1 个答案:

答案 0 :(得分:1)

是的,有可能。有一个include评论标记。我们的VSdocman支持它,我相信Sandcastle也有它。