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



Sandcastle 帮助文件生成器 (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 {}

这样的事情可能吗?

是的,这是可能的。有一个包含注释标记。我们的VSdocman支持它,我相信Sandcastle也有。

最新更新