随笔-312  评论-11907  文章-2  trackbacks-224

一个人的相貌对他的事业、家庭、生活方面的成功有多重要?或者说人的能力和相貌那个重要?虽然所有人、包括整个社会都在回避这个问题。文明社会在发展的过程中也逐渐对例如种族、性别、性取向歧视等作了法律上的约束。但一个仍旧不争的事实依然是:大部分时间里,人的想法都是出于本能,也就是所谓的“激素决定”的,“以貌取人”仍旧是这个社会的主流。

软件的界面和软件的功能哪个重要?相信那些学院出身的、理论先行的朋友自然会说功能。而如果你曾经在小型公司里工作过,或是和客户(特别是国内的政府客户)打过直接交道,或是在业内已经做了一定的时间,或者学过一些心理学知识,那么将不得不至少在心里默默认可界面的地位。

人首先是动物,然后才是人。

对于类库形式的软件来说,文档就是它给用户的界面。即使你不认同我上面的说法,懒于做这些“表面上”的工作,但现在免费的Sandcastle已经摆在你面前了,何不尝试一下轻松做出专业级别类库文档的快乐呢?园子里那么优秀的NBear,是否可以考虑一下呢?

 

使用Sandcastle创建专业的类库使用文档

最新的Sandcastle十一月CTP就是这样一个微软开发的免费的类库文档自动生成工具,可以在这里下载。Sandcastle需要操作系统为Windows 2003或XP SP2,需要安装.NET Framework 2.0以及HTML Help Workshop(这里下载)。

下载页面中还对Sandcastle有一个简单的介绍,如下(非常简单,就不翻译了):

Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments. Sandcastle has the following key features:

  1. Works with or without authored comments
  2. Supports Generics and .NET Framework 2.0
  3. Sandcastle has 2 main components (MrefBuilder and Build Assembler)
  4. MrefBuilder generates reflection xml file for Build Assembler
  5. Build Assembler includes syntax generation, transformation..etc
  6. Sandcastle is used internally to build .Net Framework documentation

下载安装完成之后,即可参考这篇文章以命令行的形式生成类似MSDN一般的CHM文档了。这篇文章同样非常简单,只有几个步骤而已,这里不赘。

 

使用SandcastleGUI让使用文档更加专业

SandcastleGUI是一个GUI程序,可以在http://www.inchl.nl/SandcastleGUI/下载。该GUI封装了命令行形式提供的Sandcastle,并对其有了非常强大的扩充:

  1. 自动在文档中插入MSDN文章链接
  2. 可以选择程序集中的某个命名空间生成文档,而不是默认的整个程序集
  3. 多种输出方式:网站、CHM帮助文件或输出二者
  4. 自定义帮助文档头部(公司LOGO以及产品名称等)
  5. 自定义帮助文章页脚(版权信息等)
  6. 在文档中插入自定义的图像
  7. 文档的代码实例中将C#语法高亮显示

SandcastleGUI可以生成如下样式的文档(极为震撼):

SandcastleGUI的界面如下,同样非常简洁:

 

 

相关资源

 

  1. Sandcastle Help Forum
  2. Sandcastle Wiki
  3. Sandcastle Blogs
  4. Create CHM or HxS build using Sandcastle
  5. SandcastleGUI
  6. HTML Help Workshop

 

写作感想

  1. 这一段时间写得比较多,学会忙里偷闲写个Blog也是个能力啊,嘿嘿
  2. 这一周的任务不少,要修改4章书稿,还要给《程序员》写篇文章,努力吧……
posted on 2006-11-13 08:26 Dflying Chen 阅读(5289) 评论(39)  编辑 收藏 所属分类: 新技术介绍

评论:
#1楼  2006-11-13 08:36 | Gavin      
给大家介绍一个长得像NDoc一样的GUI工具
SandcastleBuilder
http://www.cnblogs.com/CSharp/archive/2006/09/04/494507.html
  回复  引用  查看    
#2楼 [楼主] 2006-11-13 08:39 | Dflying Chen      
@Gavin
:)谢谢
  回复  引用  查看    
#3楼  2006-11-13 08:50 | 编写人生      
简直太棒了
  回复  引用  查看    
#4楼  2006-11-13 09:02 | Teddy's Knowledge Base      
终于出GUI了,太爽了,马上用一下~~
  回复  引用  查看    
#5楼  2006-11-13 09:11 | Winksky      
So good.
  回复  引用  查看    
#6楼 [楼主] 2006-11-13 09:12 | Dflying Chen      
@编写人生
是啊,这种界面的帮助文档,人家不服也不行啊,呵呵
  回复  引用  查看    
#7楼 [楼主] 2006-11-13 09:12 | Dflying Chen      
@Teddy's Knowledge Base
NBear里面用用哦,非常不错的
  回复  引用  查看    
#8楼 [楼主] 2006-11-13 09:13 | Dflying Chen      
@Winksky
:)
  回复  引用  查看    
#9楼  2006-11-13 09:25 | Teddy's Knowledge Base      
试了一下sandcastle+这个GUI,觉得还是有点不爽,把所有依赖的系统和外部dll权给我编译到文档了,而且,我用NDOC只要3分钟就能完成的文档编译过程,用sandcastle+这个GUI,编译了足足十几分钟。汗~~
  回复  引用  查看    
#10楼 [楼主] 2006-11-13 09:30 | Dflying Chen      
@Teddy's Knowledge Base
不会吧,可以指定Namespace的啊?
  回复  引用  查看    
#11楼  2006-11-13 09:55 | Teddy's Knowledge Base      
@Dflying Chen
是可以指定Namespace,但是,他还是会过一遍所有以来的程序集和XML,只是在生成文档时过滤没指定的Namespace,本质上编译时间没有明显的减少。时间太久了,我等的都没耐心。要用他的话也许只能写个后台的task让他daily build了。
  回复  引用  查看    
#12楼 [楼主] 2006-11-13 09:58 | Dflying Chen      
@Teddy's Knowledge Base
恩,十几分钟阿,确实比较长了……不过考虑到界面……还是忍一忍吧,呵呵
我在公司里做的项目一次编译也要十多分钟,每次这个时候我都抽空上网,嘿嘿。
  回复  引用  查看    
#13楼  2006-11-13 10:27 | Guest [未注册用户]
@Dflying Chen
编译10几分钟是不可忍受的,不要把微软产品的编译时间和普通的项目类比啊
  回复  引用    
#14楼 [楼主] 2006-11-13 10:30 | Dflying Chen      
@Guest
还好吧,因为NBear很大,对于小的项目应该会快点吧
  回复  引用  查看    
#15楼  2006-11-13 10:46 | Jeffrey Zhao      
你写的文章越来越学院派了……
  回复  引用  查看    
#16楼 [楼主] 2006-11-13 10:58 | Dflying Chen      
@Jeffrey Zhao
啥叫“学院派”?
  回复  引用  查看    
#17楼  2006-11-13 11:08 | Jeffrey Zhao      
@Dflying Chen
似乎有模版的样子,而且过于正式了,呵呵。
在Blog上看到觉得有点古怪。:)
  回复  引用  查看    
#18楼 [楼主] 2006-11-13 11:23 | Dflying Chen      
@Jeffrey Zhao
呵呵,写书写多了,呵呵。
这样别人看起来也清楚点嘛:)
  回复  引用  查看    
#19楼  2006-11-13 12:51 | yzx110[匿名] [未注册用户]
软件的界面和软件的功能哪个重要?相信那些学院出身的、理论先行的朋友自然会说功能。而如果你曾经在小型公司里工作过,或是和客户(特别是国内的政府客户)打过直接交道,或是在业内已经做了一定的时间,或者学过一些心理学知识,那么将不得不至少在心里默默认可界面的地位。

我想做那种一次性的项目,比如“或是和客户(特别是国内的政府客户)打过直接交道”,似乎界面确实比功能重要。但是比如做服务性的产品(gmail...),我想功能还是重要的多。

发表一下看法,最近一直在想这些问题.
  回复  引用    
#20楼  2006-11-13 16:20 | 深夜醉猫      
人首先是动物,然后才是人。
  回复  引用  查看    
#21楼 [楼主] 2006-11-13 18:23 | Dflying Chen      
@深夜醉猫
呵呵
  回复  引用  查看    
#22楼 [楼主] 2006-11-13 18:23 | Dflying Chen      
@yzx110[匿名]
gmail界面一样很重要啊,你的意思是Gmail的界面不好?
  回复  引用  查看    
#23楼  2006-11-14 13:37 | 刀客 [未注册用户]
刚下载了一个1.13了已经,怎么中文的好像乱码阿,要怎么设置还是就不支持阿?
  回复  引用    
#24楼 [楼主] 2006-11-14 23:03 | Dflying Chen      
@刀客
中文是乱码?我来试试看……
  回复  引用  查看    
#25楼  2006-11-15 16:10 | MS的明天      
真的不错,有机会一定要用上。
  回复  引用  查看    
#26楼  2006-11-15 19:39 | 深夜醉猫      
出现这个错误的原因是为什么?

未能找到文件“C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\system.configuration.xml”。



  回复  引用  查看    
#27楼 [楼主] 2006-11-15 21:36 | Dflying Chen      
@MS的明天
:)
  回复  引用  查看    
#28楼 [楼主] 2006-11-15 21:37 | Dflying Chen      
@深夜醉猫
没有这个文件?
  回复  引用  查看    
#29楼  2006-12-06 17:27 | abc8103.net [未注册用户]
同意"刀客"的说法,我也用这个SandcastleGUI生成了最近做的一个小项目的文档,中文的注释都是乱码?
eg:"UserDB 的摘要说明"变成了" 鐨勬憳瑕佽鏄庛€"
  回复  引用    
#30楼 [楼主] 2006-12-06 20:08 | Dflying Chen      
@abc8103.net
确实不能支持中文,我们去反映一下吧
  回复  引用  查看    
#31楼  2006-12-12 10:20 | me [未注册用户]
The module was expected to contain an assembly manifest.(Exception from HRESULT: 0x80131018)
我的出现这个错,是为什么啊
  回复  引用    
#32楼  2006-12-12 10:51 | me [未注册用户]
前一个问题解决了,是我的dll文件出错了,可是又有新问题了,凡是我加了中文注释的方法或变量在生成的文档里都没有啊
  回复  引用    
#33楼 [楼主] 2006-12-12 19:56 | Dflying Chen      
@me
目前对中文的支持还不好,还是期待下个版本吧…………
  回复  引用  查看    
#34楼  2007-03-14 11:25 | joy [未注册用户]
为什么我报错:SandcastleGUI遇到问题需要关闭?

  回复  引用    
#35楼 [楼主] 2007-03-14 11:32 | Dflying Chen      
@joy
呵呵,这个东西还不够稳定,只能先凑合用了,你可以试着调试一下,看看问题到底是什么
  回复  引用  查看    
#36楼  2007-03-25 01:56 | yaxinhoo [未注册用户]
速度是慢,但能够将类图更进一步的如果能将类的关系图加到文档中那是一个激动人心的是,
请问大哥,Custom images can be inserted into XML-documentation.如何解释,如何才能将类图打包到chm文档中。请指点,谢谢
  回复  引用    
#37楼 [楼主] 2007-03-25 12:16 | Dflying Chen      
@yaxinhoo
不好意思啊,我也不是很清楚……用得不多
  回复  引用  查看    
#38楼  2008-02-08 17:34 | yezie      
very good...............
  回复  引用  查看    

标题  
姓名  
主页
Email (博主才能看到) 
验证码 *  看不清,换一张 [登录][注册]
内容(请不要发表任何与政治相关的内容)  
  登录  使用高级评论  新用户注册  返回页首  恢复上次提交      
该文被作者在 2006-11-15 19:53 编辑过


相关链接: