用doxygen生成中英文帮助

来源:http://www.opencv.org.cn/forum/viewtopic.php?f=1&t=2635#p9188

 

用doxygen生成中英文帮助
由 chai2010 于 2008-02-18 13:41

使用doxygen可以很容易从代码中生成帮助文件。

但是有很多时候需要提供不同语言的帮助。这里我们
讲一下怎么使用doxygen生成中英文的帮助。


代码: 全选
/**
/if english
    This is English.
/else
    汉语注释
/endif
*/
class Example
{
};

 

if的命令和C语言中预处理命令相似。当english被定义的使用"This is English."注释,
否则默认使用"汉语注释"。

if的条件可以在配置文件中修改(默认为Doxyfile文件)。假如我们现要生成
english帮助,添加以下配置:


代码: 全选
ENABLED_SECTIONS       = english

 

关于ENABLED_SECTIONS的细节可以参考doxygen的说明文档。下面生成就可以得到
英文帮助文档了。如果不定义english,则默认为中文帮助文档。

希望以后能给“OpenCV扩展库”同时提供中英文帮助
http://code.google.com/p/opencv-extension-library/

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Doxygen 中文使用文档 及 适合Doxygen的注释宏 使注释更简单 统一 注释宏 已经过修改 使用简单方便 Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦。大部分有用的批注都是属于针对函式,类别等等的说明。所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您来说,就是沉重的负担。   对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。或者借助自动生成的包含依赖图(includedependency graphs)、继承图(inheritance diagram)以及协作图(collaborationdiagram)来可视化文档之间的关系。Doxygen生成帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML和Unixman page等。   一个好的程序设计师,在写程序时,都会在适当的地方加上合适的批注。如果,能够在撰写批注时,稍微符合某种格式,接着就可以透过一个工具程序依据程序结构及您的批注产生出漂亮的文件。这将令许多工作繁重的程序设计师有时间多喝几杯咖啡。   Doxygen 就是这样的一个工具。在您写批注时,稍微按照一些它所制订的规则。接着,他就可以帮您产生出漂亮的文件了。因此,Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文件。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值