三把利器快速制作代码帮助文档

1、前言

相信不少麻油都已经积累了属于自己的代码库了,不知道是否有过这样的经历:

A:听说你上次写了个通用XXX类库啊,我正好要用到,麻烦把dll发我一下。

B:好的,你等一下,我发给你。。。

。。。十分钟后

A:喂,你这个类是怎么用的啊,有没有帮助文档啊。

B:汗,没来得及做,我来和你说吧。。。

一个好用的类库,如果能配上一个好的说明文档(最好还带搜索功能),无疑是为自己和他人提供了莫大的方便,有什么想要的功能,去文档里一查,一目了然。

我最近就碰到了这个问题,甚至更为严重的是,有很多很久之前写的代码,里面实现了哪些功能,细节我已经不是很清楚了,还需要去翻看代码,非常难管理和查找。

2、准备

那么开始今天的内容,首先需要准备好三大利器啊^_^:

一、下载安装GhostDoc:http://submain.com/download/ghostdoc/

二、下载安装sandcastlehttp://sandcastle.codeplex.com/和Sandcastle Help File Builderhttp://shfb.codeplex.com/

三、安装Visual Studio(什么?这个谁没有?好吧,咱们继续往下-
-||)

3、开始

下面说一下三大利器到底怎么配合用,帮我们制造出好用的帮助文档呢?

一、给代码添加XML注释

不知道大家通常是怎么写注释的,我的习惯都是直接///然后vs帮我生成XML格式的注释,而不是简单的//或者/**/。现在有了GhostDoc(大家也可以下载GhostDoc
Pro,可以批量注释,更强大),我们就可以快速的给我们的代码添加注释了。

这一步是必不可少的,否则文档就没有了数据来源了。

如果GhostDoc不会用,可以参考这个文章,总结的很详细:http://www.cnblogs.com/RockyMyx/archive/2010/04/20/Project-Route-Using-GhostDoc.html

二、整理项目文件

这一步是做什么呢?其实主要是利用VS强大的“生成后事件”功能,配置一些宏和Marco指令,把我们代码库中的dll和注释文件xml拷贝到一起,方便制作。当然,如果您的代码全写在一个项目dll里,那这一步对您来说是没什么用处啦。反正我的库是分了20多个项目,一个个去找dll很麻烦的,所以就自动让他们放到一个输出目录下:

打开项目属性:

选择“生成”面板,允许输出XML注释文档,这步很重要

下面选择“生成事件”面板,在“生成后事件”中输入指令:

copy  "$(TargetDir)*.dll"
"$(TargetDir)..\..\..\OutPut"
copy  "$(TargetDir)*.xml"
"$(TargetDir)..\..\..\OutPut"

好了,把整个类库重新生成一下,会发现在OutPut文件夹里全部是我们要的dll和Xml:

三、使用Sandcastle Help File
Builder建立帮助文档项目

打开Sandcastle Help File Builder,后面的具体步骤可以参考这篇文章:http://www.cnblogs.com/RockyMyx/archive/2010/04/30/Project-Route-Using-SandcastleBuilder.html,也很详细。按照步骤一步步做,就可以成功生成帮助文档了。

4、效果

下面看一下效果:

时间: 2025-01-24 09:51:35

三把利器快速制作代码帮助文档的相关文章

Ajax基础教程(5)- 5.1 使用JSDoc建立JavaScript代码的文档

作为一名有经验的Web应用开发人员,你也许可以熟练地应用某种服务器端技术(或者,应用多种服务器端技术)来构建Web应用.我们已经看到,在过去几年中,服务器端技术有了长足的发展,服务器端软件开发越来越容易,也越来越健壮,相比之下,客户端技术基本上被抛在了一边.Ajax技术的横空出世使这种状况有所改观,因为开发人员现在有了一个更丰富的客户端工具箱,有大量工具可以使用.你可能不习惯使用大量的HTML.JavaScript和CSS,但是如果要实现Ajax技术,你就必须这么做.本章将介绍的工具和技术会使得

快速删除Word 2013文档段落中的硬回车的方法

  在Word文档中,有时会出现一些多余的空白段落.这样的空白段落的典型特征是其只有一个硬回车,在对文档编辑时可以通过使用"Delete"依次删除这些硬回车来删除这样的空白段落.实际上,通过编写简单的VBA代码可以快速实现对这类空白段落的删除,具体的方法就是在代码中对所有段落进行判断,判断其长度是否为1,如果是就删除该段落.下面介绍快速删除Word 2013文档段落中的硬回车的具体操作方法. 1.启动Word 2013并打开需要处理的文档,该文档中存在多余的空白段落,如图1所示. 图1

azure-Rest API 列出Blob 代码或者文档都可以

问题描述 Rest API 列出Blob 代码或者文档都可以 最近需要用rest api去list Azure存储容器里的blob 有没有现成的代码文档可以让我参考参考 解决方案 Hi 关于Rest API的编写,首先我们找出Rest API的详细的说明文档,你可以在这个地址寻找:http://www.windowsazure.cn/zh-cn/develop/reference/,找到后我们只需要按照文档编写好一些请求的信息即可.需要特别注意的是每个请求都需要被验证,关于Azure存储服务验证

如何制作中文API文档

问题描述 现在大多数API文档制作工具生成的都是英文的,头说要叫制作一个目录就能是中文的,最好每个接口还可以添加示例的.百度了很久都没有找到能制作中文API文档的,所以来求助了.难道我看的那些中文API都是手动翻译的吗?另说一句,要的是能支持C#的. 解决方案 解决方案二:只有英文的,没有中文的,中文的要自己写,不是导出了事解决方案三:就是还是要自己写中文是吧,那有什么能写中文的工具呢?解决方案四:引用1楼starfd的回复: 只有英文的,没有中文的,中文的要自己写,不是导出了事 那有什么写中文

在Word2016中快速编辑PDF格式文档

  在Word2016中快速编辑PDF格式文档           首先在资源管理器中找到想要编辑的PDF文件,右击它,从右键菜单中选择"打开方式→Word 2016". Word将自动启动,并弹出一个提示框,大意是转换后的文档与原PDF文档的格式会有些不同. 点击"确定",Word开始打开操作,如果PDF文档很大,这个过程会有些漫长.当PDF文档转换完成后,可能还会在上面出现安全提示,询问你是否确定要编辑. 如果需要编辑,可以点击"启用编辑"按

如何快速提取 Word 2007 文档中的所有图片

在Word文档中插些图片确实很炫.图文并茂省掉不少啰嗦.但是,怎么才能把文档中的图片一次全部提取出来呢? 如何快速提取 Word 2007 文档中的所有图片? 全新的 Word 2007 的界面是不是让你很兴奋啊?下面这个小贴示可能对你有帮助: 在Word文档中插些图片确实很炫.图文并茂省掉不少啰嗦.但是,怎么才能把文档中的图片一次全部提取出来呢? Word 2007 文档(.docx)实质上是个压缩文档,把后缀名改成 .zip 可以直接打开.这招不能用在老版本的 Word 文档(.doc 文档

WPS如何快速将多个文档合并成一个文档

  举例说明,我们要做的就是将以下三个文档快速合并至一个空白文档: 具体操作方法如下 1.我们建立一个空白文档,在此空白文档中,依次选择 插入==>对象==>文件中的文字: 2.然后将要合并的三个文档逐一勾选,点击打开: 最终效果如下: 注意:要按照合并的先后顺序给待合并文档命名,最好在前面加上类似1.2.3的序号,否则将引起合并错乱.

开启并排比较功能 快速比较两份WPS文档

有时我们需要将两份WPS文档进行内容比较,使用WPS文字提供的并排比较功能,实现同步滚动比较,可以迅速分辨文档之间的内容区别. 使用方法 步骤一:用WPS文字同时打开两个需要比较的文档: 步骤二:在主菜单选择"窗口 | 与 xxx 并排比较".其中"xxx"是需要比较的文档名称. 并排比较 此时,两个文档会以垂直平铺的方式并排打开,同时在工具条上会出现并排比较的工具条,而且自动默认打开"同步滚动"功能. 并排比较工具条 ·第一个按钮:设置同步滚动

办公软件技巧快速浏览长word文档

编辑长文档时,由于文档内容非常庞大,如果能在文档中建立一些直接返回目录的链接,对于文档的浏览与查看将是非常方便的电脑应用技巧.在Word2003中使用交叉引用可以帮助用户快速浏览Word长文档. 第1步,首先要确定插入点.在合适的位置输入"(返回)"字样,并将光标置于"返回"的后面.然后依次单击"插入"→"引用"→"交叉引用"菜单命令. 第2步,接着选择引用内容.在打开的"交叉应用"对话