vs2019 使用 SHFB-Sandcastle Help File Build 文档生成工具 自动生成程序文档

网上别人传的都比较老了,请到GitHub下载最新版本:https://github.com/EWSoftware/SHFB/releases

 vs2019,安装好sandcastle后,如果直接使用GUI界面的,会有bug,报错“The tools version "15.0" is unrecognized.

问题具体见:https://github.com/EWSoftware/SHFB/issues/790

原作者给出了答案:

So, for now, if you have Visual Studio, use it. The standalone GUI is only there for people that don't have Visual Studio anyway so there's really no need to use it if you've got Visual Studio.

意思:如果你有VS了,那就在VS 内使用插件的形式,不要用GUI 了。

详细文档说明:http://ewsoftware.github.io/SHFB/html/78507051-0fc0-479b-9d47-78a10398eaf2.htm

 

下面用插件形式。

1、设置程序项目的属性,允许编译的时候产生xml说明,

vs2019 使用 SHFB-Sandcastle Help File Build 文档生成工具 自动生成程序文档

2、在解决方案下新建项目,不同版本的VS界面不一样,要找到 这个带图标的项目就可以。

vs2019 使用 SHFB-Sandcastle Help File Build 文档生成工具 自动生成程序文档

3、添加代码项目

vs2019 使用 SHFB-Sandcastle Help File Build 文档生成工具 自动生成程序文档

4、依次先编译代码,最后编译这个文档。

vs2019 使用 SHFB-Sandcastle Help File Build 文档生成工具 自动生成程序文档