• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

Sandcastle----强大的C#文档生成工具

原作者: [db:作者] 来自: [db:来源] 收藏 邀请

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

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

      5.点击上面的生成菜单或者按钮,就可以直接打开生成过程界面,在这里可以直接查看生成过程中的一些提示和错误.生成完成后,一个和MSDN风格一致的文档就出来了:
        
    
     6. 而且支持在文档中插入图片,插入代码等功能。
     7.代码规范是最根本的前提,一定要在代码中提加足够的注释。

资源: 
          Sandcastle Help File Builder:    http://shfb.codeplex.com/
          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

 

 


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
上一篇:
树状结构TreedatastructureinC#发布时间:2022-07-13
下一篇:
C#中的Dictionary字典类介绍发布时间:2022-07-13
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap