控制SHFB项目上API文档的层次结构

时间:2018-09-26 14:16:37

标签: c# visual-studio shfb

我有一个C#项目,其中包含一个API,该API充当第三方产品的“外观”,直接引用其DLL。由于需要维护与该第三方产品的两个版本兼容的相同API,因此我在解决方案中添加了第二个项目,其中的引用指向了较新的第三方产品,包括第一个项目中的所有代码文件。链接”。这两个项目具有相同的名称和相同的功能,只是引用了不同的

当我想在解决方案上使用SandCastle帮助文件生成器(SHFB)时,我向解决方案中添加了一个新的SHFB项目。然后在“文档源”上,添加了两个文档源,每个API项目一个。

但是,当我生成文档时,SHFB会按名称空间组织它。由于代码相同(由于文件添加为链接),我最终得到一个CHM文件,其摘要如下:

命名空间A
|
+ IAAA接口
| |
| + IAAA方法
| + IAAA属性
|
+ AAA级
|
+ AAA方法
+ AAA属性

但是,我希望在命名空间上方具有一个层次级别,以标识目标的第三方库,例如:

API PRODUCT 1.0
|
+命名空间A
|
+ IAAA接口
| |
| + IAAA方法
| + IAAA属性
|
+ AAA级
|
+ AAA方法
+ AAA属性
API PRODUCT 2.0
|
+命名空间A
|
+ IAAA接口
| |
| + IAAA方法
| + IAAA属性
|
+ AAA级
|
+ AAA方法
+ AAA属性

有人知道如何实现吗?

谢谢

0 个答案:

没有答案