Your Ad Here
首页 | 编程语言 | 网站建设 | 游戏天堂 | 冲浪宝典 | 网络安全 | 操作系统 | 软件时空 | 硬件指南 | 病毒相关 | IT 认证
软讯网络 > 编程语言 > C/C++ > 使用doxygen生成用户手册
【标  题】:使用doxygen生成用户手册
【关键字】:doxygen
【来  源】:http://www.cublog.cn/u/9337/showart.php?id=188839

使用doxygen生成用户手册

Your Ad Here
今天上班就得到任务,要写一个chm的用户手册,自己操刀用html,太多重复的东西了,麻烦,还要考虑复杂的交叉链接关系,网上搜索一下,也没有找到好工具.突然想用doxygen来生成,翻开doxygen的chm版文档,正是用他自己生成的.于是研究了一会语法,写了如下的文档.
 

/*!@defgroup groupbz 标注
    标注工具用于标注指定封闭多边形的边长和面积.
    可以通过@ref bzsz "标注设置"来设置标注参数,
@section bz 标注
    标注根据多边形的点坐标集计算边长,并完成标注,只可标注封闭的PolyLine(多线段).
    标注面积来源于CAD内置的面积,小数位数保留一位.
    @code 必须是封闭的多边形,对于非封闭多边形可以使用CAD命令bpoly来构造.    
    @endcode
<em>标注程序无法标注SPline(样条曲线),Circle(圆),Ellipse(椭圆),REGION(面域)以及其它类型图形,他们在某些时候表现和多线段一样,如果发现未正常标注的图形元素,请检查其标注类型.</em>
    - 标注半面积部分
        -# 对于图内,任意线型不是\e ByLayer(随层)的多边形,将会标注为半面积,即\e "area/2" 格式,并在面积上方标注\e "阳台"

    - 不标注
        -# 如果不想标注某一部分,可以使该部分多线段不封闭,也可以置图形为白色,然后在@ref bzsz "标注设置"中设置不标注白色多边形来实现.使一个已闭合的多线段打开可以可以使用CAD的\e explode(炸开) 或者\e pe 命令

    - 挖空标注
        -# 当多线段内部内含多线段时,标注程序会根据识别情况,自动标注为上空,并在外围多线段的标注面积中扣除面积.
    @note <em>此功能识别率并非百分之百,当多线段比较复杂时,部分内含多线段并不会被识别扣除面积,请仔细检查所有内含多线段,检查是否存在应该扣除面积但并未标注上空的部分.</em>

    标注效果图如下:
    @image html bz.jpg

@section bzsz 标注设置
    - 一个测试
    @subsection s22 子目录子目录
      - 再测试
    @ref s1 "查看另一段"
@code
    嘿嘿
    
@endcode

@see @ref group "标注设置 "
    @author abao++
    @version 1.0
    @date 2006-10-23
    

*/

 

用doxygen编译后,效果如下,自我感觉还不错,用这个我们可以更多的关注于文档本身的内容,而不用去关心链接关系以及排版,doxygen的默认排版已经很不错了,如果加上一个不错的css样式表,那效果可是非常的好,不过我还没有来得及写css.效果如下,我得继续努力了.

i=i++;后:【上一篇】
我的J2EE学习笔记(1):【下一篇】
【相关文章】
  • Vs2005用,生成Doxygen格式版本注释以及函数注释的宏
  • 使用代码文档工具 doxygen
  • C++ 程序文档生成器介绍(doxygen)
  • 十分钟文档化你的C++代码——DoxyGen
  • 十分钟文档化你的C++代码——使用DoxyGen
  • 提交了一个Doxygen1.4.7的bug和patch
  • doxygen使用
  • Doxygen 不错
  • Doxygen 源代码文档自动生成器的使用笔记
  • doxygen 手册
  • 【随机文章】
  • 上海语文教材删除“狼牙山五壮士”的举动让人们更加鄙视这个城市
  • 证书遗失、损坏后可以补办吗?
  • 整数划分
  • 分治算法对任意的n值构造相应的格雷码
  • 网络是否能真正发挥效益还要看网络的管理
  • 【用C语言写一个内存管理程序】
  • RSS做的比FEEDSKY好
  • 用php来检测proxy
  • PE文件格式详解(4)
  • 正则表达式判断email和URL
  • 【相关评论】
    没有相关评论
    【发表评论】
    姓名:
    邮件:
    随机码*
    评论*
          
    |  首 页  |  版权声明  |  联系我们   |  网站地图  |
    CopyRight © 2004-2007 bbb软讯网络 All Rigths Reserved.