zoukankan      html  css  js  c++  java
  • VS文档自动生成

    VS2008文档自动生成

    (发现,Sandcastle主要是用于C#项目。里面的注释都是XML格式的。不太适合VC的。最终还是得用Doxygen)

    一、Sandcastle简介:

    Sandcastle(CodeName)是微软出的用于编译发布组件(Assembly)信息的一个工具,其前身为发布VS2005之前,MS内部开发了一个用于生成帮助文档的工具。

    二、SandcastleNDoc的简单比较:

    NDoc.Net2003下的文档生成工具,它是一个开源的东东。目前已经停止开发,最新版本不支持2.0

    它们都是通过反射和Xslt技术,从dll文件及其注释(编译时加/doc参数得到)中得到一个完整的帮助文档,文档格式可以是htmlchm甚至是任何自定义的格式。

    当前Sandcastle最新版本是June CTP,使用的方式仍然是命令行,不提供GUI支持;而且官方网站上给出的使用说明:其只能支持单一的dll,对于Solution仍然没有任何说明。

    三、如何利用Sandcastle自动生成.NET2.0开发帮助文档

    A.软件安装准备工作:(下载网站:http://shfb.codeplex.com/

    1、 必备软件:HtmlHelpWorkshop.exe 网上到处都有;如果本机已经安装就无需理会;

           2、下载该软件,网址:http://shfb.codeplex.com/

                 解压找到文件夹InstallResources;可找到两个安装包Sandcastle_2710.msi;SandcastleHelpFileBuilder_1950.msi

           3、开始安装,需要装两个软件(最好默认安装到C:下)

                 先安装Sandcastle_2710.msi

                后安装SandcastleHelpFileBuilder_1950.msi

           4、安装完毕后,在程序中可以找到“Sandcastle Help File Builder GUI”执行文件,运行:(里面已经新建了一个工程-7)

    VS2008自动生成帮助文档 - 柳北风儿 - 柳北风儿~~~~~~~欲宇仙炅
     

           使用步骤:

            1、点击“File”--> New Project -->弹出对话框,输入工程名称,比如:AA,点击保存

            2、见AA工程如下图

                     VS2008自动生成帮助文档 - 柳北风儿 - 柳北风儿~~~~~~~欲宇仙炅

     

            3、点击“右边AA”下面“Documentation Source”,点击右键Add,选择我们开发项目已经编译好的dll和xml文件(注意:项目编译                  必须输出 xml文件,方法见下面解说)

            4、配置相关属性;

                       ①、FrameworkVersion --- 选择对应项目的.net版本(目前支持到4.0)

                       ②、ProjectSummary     ---  项目说明-编译后的chm--Title属性名称

                       ③、HtmlHelpName       ---   输出chm文件的名称

                       ④、HelpTitle                  ---   文件标题说明

                       ⑤、HelpFileFormat      ---   选择HtmlHelp1

                       ⑥、Language               ---   默认选中“英语(美国)”

                       ⑦、CopyrightText        ---   你的版权说明

                       ⑧、DocumentInheritedFrameworkMembers   ---- false    true<将屏蔽继承过来的自带的一些方法说明>

                       ⑨、DocumentInheritedMembers                       ---- false    true<将屏蔽继承过来的自带的一些方法说明>

                       ⑩、OutputPath            ---  输出chm的文件夹

                       其他属性可默认....

              5、点击“Bulid the help file”按钮进行编译操作,

    VS2008自动生成帮助文档 - 柳北风儿 - 柳北风儿~~~~~~~欲宇仙炅

               

     

     解说:项目生成输出xml文件操作---》点击项目属性,弹出对话---生成--勾选中 输出XML文档文件,下次编译即可输出xml文件

     

     

    转载自http://blog.163.com/qimo601@126/blog/static/15822093201211129328968/

  • 相关阅读:
    svg使用
    人生是 立体, 不是平面, 股票大作手不太好的结局
    react 管理平台
    首页性能优化
    vue 安装插件
    python中如何对list之间求交集,并集和差集
    Java中String直接复制和new String创建对象的区别以及equals和==的区别和效率对比
    关于二叉树的总结
    Postgresql 数据库,如何进行数据备份以及导入到另外的数据库
    Java List详解,面试中应该如何解答关于List的问题
  • 原文地址:https://www.cnblogs.com/ZJ199012/p/3482343.html
Copyright © 2011-2022 走看看