使用GhostDoc为.Net项目自动生成帮助文档

开发的同时编写注释的好处不言自明,不仅有助于团队成员迅速熟悉代码,也方便以后自己的维护。将注释导出为chm文档当然更便于阅读。

.Net平台导出注释为帮助文档主要方法有两种。
一种是先通过项目属性中配置生成xml文档,然后在通过SandCastle将xml生成为hhc,hhk,hhp三个文件,然后在通过HTML Help Workshop将这三个文件编译为chm。这种方法步骤繁琐,且费时费力,导出来的效果也不好看,显得很杂乱。这种方法的生成教程看这里:http://blog.csdn.net/chtnj/article/details/8278360
另一种是通过VS插件GhostDoc自动导出为chm文档。速度略快,导出方便且美观易读。下面说一些怎样用GhostDoc导出。

安装

最新版的GhostDoc for vs可以在这里找到:
https://marketplace.visualstudio.com/items?itemName=sergeb.GhostDoc
现在是2017版本,如果自己电脑上安装的低于2017的话,可能会提示:
这里写图片描述
我这里是VS2015。在CSDN上找到了支持2015版的GhostDoc,链接在这里:
http://download.csdn.net/detail/y276827893/9606175
其他版本没测试,大家可以试下看能不能用。

下载后直接一步步安装就可以,安装前要关闭VS。

使用

安转完成后打开VS,可以在工具菜单下找到GhostDoc,选择“Build Help File”:
这里写图片描述

免费版本只能配置路径,其他项在个人版中才能配置,不过默认的一般够用了:
这里写图片描述

点击ok等待生成完成后会自动打开chm所在文件夹,效果还不错:
这里写图片描述

猜你喜欢

转载自blog.csdn.net/anjingshen/article/details/73520225