注册 登录  
 加关注
   显示下一条  |  关闭
温馨提示!由于新浪微博认证机制调整,您的新浪微博帐号绑定已过期,请重新绑定!立即重新绑定新浪微博》  |  关闭

樱之花

叶散的时候,你明白欢聚;花谢的时候,你明白青春.

 
 
 

日志

 
 
关于我

分类中“我的实验室”是我在日常工作中的一些知识总结,有些写的比较匆忙,可能大家在阅读时会产生困扰,后期有时间我会重新整理编辑,谢谢大家的到访,您们的支持是我前进的动力!

网易考拉推荐

Sandcastle(Sandcastle Help File Builder)C#文档生成工具-VB.NET注释文档生成器  

2011-10-10 15:14:59|  分类: .NET/C# |  标签: |举报 |字号 订阅

  下载LOFTER 我的照片书  |

     最近客户索要产品的二次开发类库文档,由于开发过程中并没有考虑过此类文档,而且项目规范比较,持续时间比较长,经手人比较多,还真是麻烦,如果人工制作文档需要是一个比较大的工程.还好有这个文档生成工具,能够根据项目生成文档,而且格式看起来确实很专业. 
     Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具。它从dll文件及其xml注释文件能够生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具,整个生成过程十分简单,而且SHFB工具看起来很强大,不仅能够直接配置生成文档的各个属性,而且还支持很灵活的扩展设置,为我们提供完美的.NET类库文档成为一个可能。 
      来一步一步的看下整个生成过程:
     1.下载最新的Sandcastle后安装。
     2.下载Sandcastle Help File Builder,此软件可以提供图形化的操作界面,比较方便。

需要注意的是,最新版可能需要.NET FRAMEWORK4.0框架的支持,因此你可能还需要安装.NET FRAMEWORK4.0.
     3.安装完成后直接打开Sandcastle Help File Builder 新建项目,主窗口会直接打开项目属性,这里就是对生成文档的主要配置区域。我们先添加需要生成文档的源。右击项目中的Documentation Sources可以添加多种文件类型(sln,proj,xml,dll,exe)  
     4.对主要的属性进行设置. 
       FrameworkVersion:  选择对应的Framework版本 
       HelpFileFormat :  选择需要生成的文档的格式. 注意这里选定的格式要在下面对应的地方进行设置. 
       注意对于不同的格式还需要安装不同的编译工具 Helpe1x(chm)需要安装Microsoft HTML Help(最好安装在默认硬盘C下),Helper2x(Hxs)需要安装 Hxcomp
      NamespaceSummaries:  选择需要生成的命名空间,直接点击开窗选择。这可强大多了,之前用命令行或者其它工具都是要手动输入。 
      Lanugages :语言一定要选择中文,这会使一些文档里的一些文字自动生成中文 
      CopyrightHref:版权链接 
      CopyrightText: 版权文字 
      HelpTitle: 文档标题 
      HtmlHelpName:文档生成文件名称 
      PresentationStyle: 这里现在支持vs 2005,Prototype等格式 ,根据自己需要选择 
      OutputPath:生成路径 
      Show Missing Tags:下面的一些设置根据需要在最终版生成时设置成True,不然会在文档中出现红色的提示. 
    设置完成的界面如下

Sandcastle----C文档生成工具-VB.NET注释文档生成器 - IDesire - 樱之花 yinzhihua2008
 
5.点击上面的生成菜单或者按钮,就可以直接打开生成过程界面,在这里可以直接查看生成过程中的一些提示和错误.生成完成后,一个和MSDN风格一致的文档就出来了: 
Sandcastle----C文档生成工具-VB.NET注释文档生成器 - IDesire - 樱之花 yinzhihua2008
 

 6. 而且支持在文档中插入图片,插入代码等功能。 
     7.代码规范是最根本的前提,一定要在代码中提加足够的注释。

资源:  

Sandcastle:http://www.codeplex.com/Sandcastle
          Sandcastle Help File Builder:    http://shfb.codeplex.com/ 
          Microsoft HTML Help http://msdn.microsoft.com/en-us/library/ms669985(VS.85).aspx
          SandcastleGUI:http://www.inchl.nl/SandcastleGUI/ 之前一直使用的另外一个Sandcastle生成工具 
          用Sandcastle和Help Integration Wizard把文档集成到Visual Studio    
           http://www.cnblogs.com/fox23/archive/2008/09/09/using-sandcastle-integrated-help-documents-into-visual-studio.html

  评论这张
 
阅读(1730)| 评论(0)
推荐 转载

历史上的今天

在LOFTER的更多文章

评论

<#--最新日志,群博日志--> <#--推荐日志--> <#--引用记录--> <#--博主推荐--> <#--随机阅读--> <#--首页推荐--> <#--历史上的今天--> <#--被推荐日志--> <#--上一篇,下一篇--> <#-- 热度 --> <#-- 网易新闻广告 --> <#--右边模块结构--> <#--评论模块结构--> <#--引用模块结构--> <#--博主发起的投票-->
 
 
 
 
 
 
 
 
 
 
 
 
 
 

页脚

网易公司版权所有 ©1997-2017