使用GhostDoc为.Net项目自动生成帮助文档
来源:互联网 发布:淘宝的游戏藏宝湾 编辑:程序博客网 时间:2024/05/16 23:53
开发的同时编写注释的好处不言自明,不仅有助于团队成员迅速熟悉代码,也方便以后自己的维护。将注释导出为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所在文件夹,效果还不错:
- 使用GhostDoc为.Net项目自动生成帮助文档
- 使用GhostDoc为代码生成注释文档
- 使用GhostDoc为代码生成注释文档
- .Net开发必备十大工具详解之使用GhostDoc为代码生成注释文档
- C#.NET必备工具GhostDoc为代码生成注释文档
- 使用Sandcastle工具为.NET项目工程生成一份项目帮助文档chm
- 自动生成.NET项目帮助生成
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- 使用Doxygen生成net帮助文档
- 使用Doxygen生成net帮助文档
- .NET项目工程生成一份项目帮助文档chm
- webAPI 自动生成帮助文档
- webAPI 自动生成帮助文档
- Xcode常用插件使用及自动生成帮助文档
- 使用 Eclipse 帮助系统为项目编制文档
- 使用 DocFX 生成 .Net/Unity项目文档
- Web Api 自动生成帮助文档
- WebAPI——自动生成帮助文档
- Vuforia的学习(七)如何让游戏内摄像机跟着手机陀螺仪旋转
- 操作系统原理课后习题8.8
- 并查集( Roads and Libraries locked)
- JSP页面的组成
- 不要去眼红别人的高工资,重要的是把技术练到家,既然选择了前端,就要坚持在这条路上走下去
- 使用GhostDoc为.Net项目自动生成帮助文档
- Spring带给我们的好处
- Hyperopt 安装
- 题目三 蛇形填数(二)
- HTML5中代码调试,快捷键F10和F11区别
- jquery如何让页面的滚动条返回到顶部
- hdu 1754 I hate it (线段树,树状数组)
- 数组(Array)详解;
- 欢迎使用CSDN-markdown编辑器