Sandcastle Help File Builder 生成NET帮助文档
2024-10-10 22:57:45
Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcastle
Sandcastle生成的输出结果具有以下特点:
Ø 类似于MSDN布局的界面。
Ø 自动生成索引项、内容项目表、主题块和页面布局,提高一致性和熟悉程度。
Ø 自动生成语法宣称部分。
Ø 自动生成继承表。
Ø 代码彩色化。
Ø 提供多种风格和语言选择,终端用户可从中选择自己最喜欢的形式。
Ø 输出结果以HTML和CSS形式显示,微软承诺将来提供更多选择。
SHFB(Sandcastle Help File Builder)是Sandcastle的GUI(图形用户界面)版本,Sandcastle 本身是一个console的程序。
1. 下载完shfb后解压安装,本文用的是SHFBGuidedInstaller_1980,双击“SandcastleInstaller.exe”运行
2.看见此界面后直接next,不用管什么配置
3.安装完成后在vs中可以找到“Documentation”模板,如果没有找到在下载的文件中找到“SHFBVisualStudioPackage_1980.vsix”重新安装一下
安装后重新启动一下vs
安装成功后会弹出下图对话框。
4.新建项目选择“Sandcastle Help File Builder Project”,在新建的项目上右键选择生成文档的格式类型
5.在“Visibility”中选择过滤哪些不需要的选项,然后直接点击“Close”就可以了。
6.在项目工程有右键属性,然后在”生成“中勾选”XML文档文件“,这个不勾选那个方法的说明将不会在生成的帮助文档中显示。
如果点击”Build“的时候报错,注意查看下面的输出日志。
如有疑问欢迎交流!
最新文章
- PHP之时间处理
- objective-c第七章课后练习2
- Java实现点击一个Jlabel增加一个Jlabel的小功能
- jqMobile中pageinit,pagecreate,pageshow等函数的执行顺序
- Linux磁盘及文件系统管理
- liunx几台机器直接用ssh链接
- Observer Pattern
- linux mail命令用法
- /proc/sysrq-trigger
- HTML DOM (文档对象模型)
- 点击grid单元格弹出新窗口
- postgresql如何维护WAL日志/归档日志
- php留言板的实现
- 【一天一道LeetCode】#117. Populating Next Right Pointers in Each Node II
- webservice生成客户端代码
- python tcp黏包和struct模块解决方法,大文件传输方法及MD5校验
- Jenkins系列之三——centos7.4+GitLab+Jenkins部署
- inline-blcok 之间的空白间隙
- 前端开发 —— google chart 的使用
- 取Mac地址