doxygen注释使用中应该注意的问题

《doxygen注释使用中应该注意的问题》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、1.没有内容的注释12.位于代码右侧的注释13.一组函数，#define的注释14.多行注释的分行问题25.隐藏私有与保护方法与属性26.隐藏其他内容2Doxygen注释使用中应该注意的问题作者郑宇斌版本1.0日期10/04/131.没有内容的注释/***@fileDataProxy.h*@briefcore数据代理适配层*@sa参考对象*@authorzhangzewu*@date19/11/2012*详细描述*/问题：因为没有内容，上例标红的注释应该删除。2.位于代码右侧的注释BOOLTagUnderLine(std::stri

2、ng&str,constchar*pszText,boolbFlag);///下划线问题：上例中标红的注释应为///<下划线,否则会被当做下面代码的注释。3.一组函数，#define的注释///参数类型，与value的类型相对应#defineDVTS_int"x01"#defineDVTS_float"x02"#defineDVTS_string"x03"#defineDVTS_indicator"x04"#defineDVTS_matrix"x05"#defineDVTS_dzhobj"x06"问题：上例中的注释是对这

3、组#define的注释，但在Doxygen生成的文档中只会出现在第一个#define下面，其他#define都会没有注释。应将这组#define分组，然后将注释放在组名的下面。/**@name#define-1（组名）*参数类型，与value的类型相对应（整个组的注释）*///@{#defineDVTS_int"x01"#defineDVTS_float"x02"#defineDVTS_string"x03"#defineDVTS_indicator"x04"#defineDVTS_matrix"x05"#defineDV

4、TS_dzhobj"x06"//@}2.多行注释的分行问题///包信息///第0、1位表示事务的状态信息：1-开始;2-持续中;3-结束///第2位表示消息是同步还是异步:0-同步;1-异步///第3位表示消息是函数还是命令:0-函数;1-命令///第4位表示消息是否执行成功:0-执行成功;1-执行失败。仅仅在返回值是有效问题：上例的注释在生成的文档中会一行显示，不易理解，应用
将注释分行：/**包信息*
第0、1位表示事务的状态信息：1-开始;2-持续中;3-结束*
第2位表示消息是同步还是异步:0-同步;1-

5、异步*
第3位表示消息是函数还是命令:0-函数;1-命令*第4位表示消息是否执行成功:0-执行成功;1-执行失败。仅仅在返回值是有效*/5.隐藏私有与保护方法与属性不在生成文档中显示私有方法与属性，只要在Expert->Build里面勾选EXTRACT_ALL，并不勾选EXTRACT_PRIVATE.不在生成文档中显示保护方法与属性，需要在不显示私有方法与属性的基础上，在所有“protected：”关键字后加上@privatesection命令：protected:/**@privatesection*/6.隐藏其他内容需要隐

6、藏其他内容，可以在要隐藏的内容前后加上@cond与@endcond命令，如：///@condtypedefstruct{size_tstart;intstep;///可以<0size_tend;///值的个数inlinesize_tCount()const{returnint(end-start)/step+1;}///位置计算，错误返回0xffffffffinlinesize_tIndex(size_tv)const{return(v-start)%step==0?(v-start)/step:0xffffffff;}}Range

7、;///@endcond