【原创】三把利器快速制作代码帮助文档

标签: 原创 把利 制作 | 发表时间:2011-10-26 16:59 | 作者:刺客之家 We_Get
出处:http://www.cnblogs.com/

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很麻烦的,所以就自动让他们放到一个输出目录下:

打开项目属性:

image

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

image

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

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

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

image

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

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

4、效果

下面看一下效果:

image

作者: 刺客之家 发表于 2011-10-26 16:59 原文链接

评论: 3 查看评论 发表评论


最新新闻:
· iPhone 9月份应用下载量减少6%(2011-10-26 22:44)
· IBM完成对安全软件厂商Q1 Labs并购(2011-10-26 22:43)
· 分析称苹果与中国移动合作将带来700亿美元营收(2011-10-26 22:01)
· 亚马逊Kindle Fire增产数百万台(2011-10-26 21:56)
· 微软下月在澳大利亚推Zune音乐服务(2011-10-26 21:32)

编辑推荐:新起点:诺基亚 Windows Phone 发布总结

网站导航:博客园首页  我的园子  新闻  闪存  小组  博问  知识库

相关 [原创 把利 制作] 推荐:

【原创】三把利器快速制作代码帮助文档

- We_Get - 博客园-首页原创精华区
相信不少麻油都已经积累了属于自己的代码库了,不知道是否有过这样的经历:. A:听说你上次写了个通用XXX类库啊,我正好要用到,麻烦把dll发我一下. B:好的,你等一下,我发给你. A:喂,你这个类是怎么用的啊,有没有帮助文档啊. B:汗,没来得及做,我来和你说吧. 一个好用的类库,如果能配上一个好的说明文档(最好还带搜索功能),无疑是为自己和他人提供了莫大的方便,有什么想要的功能,去文档里一查,一目了然.

模型制作

- 小鱼儿 - 非正常人类研究中心 – Mtime时光网
1.材料:一大袋的一次性筷子(花了60块钱);5支502胶水;5张粗砂纸;记号笔一只;锋利的美工刀片若干,破剪刀一把. 就是这种屌毛筷子,质量也太他妈的差了点,80%都是弯的 . 随便提一下:我的脚丫子还是蛮性感滴 . 开始动工了!!  先做门框跟房子的底架. 3.不好意思,忘了交代一下了,我是先画图纸的,看到那张纸了没有.

ETL概述(原创)

- - ITeye博客
ETL,Extraction- Transformation-Loading的缩写,即数据抽取(Extract)、转换(Transform)、装载(Load)的过程,它是构建数 据仓库的重要环节. ETL是将业务系统的数据经过抽取、清洗转换之后加载到数据仓库的过程,目的是将企业中的分散、零乱、标准不统一的数据整合到一起,为 企业的决策提供分析依据.

备份 Gmail 的五把利刃

- 晓刚 - 谷奥——探寻谷歌的奥秘
你在Backupify注册,并且授权你的gmail权限给它,你无需做任何事情,Backupify将会自动的从google的服务器上将你邮箱的个人数据保存至其自己的服务器,大概只需要2-3天的时间就可以完成了. 你邮箱里面的新的邮件也将会在你发送或者接手后,持续不断的增添值backupify帐号. Backupify不仅仅备份gamil数据,它还提供Facebook、Flickr、Google Docs、Twitter等众多其他站点的数据备份服务.

教你制作蕾丝灯

- 毛毛鸭 - 玩意儿
很可爱和容易,需要准备一个大气球、壁纸胶,还有漂亮的花边布料即可. 将气球吹好,将壁纸胶刷在布料上,然后将布料粘贴在气球上,等1天或者更长时间过后,凝固住了,就将气球放气取出,一个漂亮的蕾丝灯就出现了. 本文原始链接:http://www.cngadget.cn/doily-lamp-diy-mdp.html.

iReport5.6.0 linechart 制作方法

- - CSDN博客研发管理推荐文章
iReport 官网和文档上关于chart设计以饼图和JDBC源作为例子,但更多的情况下由于报表中的数据需要首先加工处理,因此更多的是从JavaBeans set datasource从获取数据,另外linechart也是使用很多的一种chart工具,本文就记录在iReport中通过JavaBeansset datasource 获取数据,继而生成linechart报表的过程.

cocos2d+TexturePackerGUI动画制作

- - CSDN博客移动开发推荐文章
转载请注明出处: http://blog.csdn.net/oyangyufu/article/details/25168047. 1、下载安装TexturePackerGUI. 地址: http://www.codeandweb.com/texturepacker. 2、制作plist文件和png图片.

PL/SQL动态SQL(原创)

- - ITeye博客
使用动态SQL是在编写PL/SQL过程时经常使用的方法之一. 很多情况下,比如根据业务的需要,如果输入不同查询条件,则生成不同的执行SQL查询语句,对于这种情况需要使用动态SQL来完成. 再比如,对于分页的情况,对于不同的表,必定存在不同的字段,因此使用静态SQL则只能针对某几个特定的表来形成分页.

将原创进行到底

- - 杨晖的博客-TV2.0的实验田
——来源《投资者报》 记者 占昕.     “六年前的某一天,杨晖来到我当时工作的外滩中心楼下的咖啡厅,她对我讲她要办一个叫《波士堂》的电视节目. 俺当时心里咕嘟着,‘她也太想当boss了吧’. ”这是唯众六周年晚宴,睿狮广告传播的首席战略官沈柏屏在留言卡片上写下的一段话. 或许你尚来不及知道她的名字,但你一定知道《波士堂》、《谁来一起午餐》、《开讲啦》、《这会儿不上班》等风靡全国的电视节目.

[原创] 国人原创咆哮体《哔哔儿你伤不起》

- Tony - 黑莓时光
这是来自新浪微博上的国人哔哔儿 廖小肥 的原创咆哮体内容,非常犀利也非常有爱,快快分享阅读. 《哔哔儿你伤不起》| 原创咆哮体 by @廖小肥. 谁跟老子讲黑莓是世界上最屌的手机啊. 尼玛谁说黑莓在911事件中一战成名啊. 那是因为老外的黑莓都开通BIS和BES啊. 国内玩黑莓的淫才TM百分之几啊.