1、1. 没有内容的注释 12. 位于代码右侧的注释 13. 一组函数,#define 的注释 .14. 多行注释的分行问题 25. 隐藏私有与保护方法与属性 26. 隐藏其他内容 2Doxygen 注释使用中应该注意的问题作者 郑宇斌版本 1.0日期 10/04/131. 没有内容的注释/* * file DataProxy.h* brief core数据代理适配 层* sa 参考对 象* author zhangzewu * date 19/11/2012* 详细描述*/问题:因为没有内容,上例标红的注释应该删除。2. 位于代码右侧的注释BOOL TagUnderLine(std:string
2、/下划线问题:上例中标红的注释应为/将注释分行:/* 包信息* 第0、1 位表示事务的状态信息:1- 开始; 2-持续中; 3-结束* 第2位表示消息是同步 还是异步: 0-同步; 1-异步* 第3位表示消息是函数 还是命令: 0-函数; 1-命令* 第4位表示消息是否 执行成功: 0-执行成功; 1-执行失败。仅仅在返回值是有效*/5. 隐藏私有与保护方法与属性不在生成文档中显示私有方法与属性,只要在Expert-Build里面勾选EXTRACT_ALL,并不勾选EXTRACT_PRIVATE.不在生成文档中显示保护方法与属性,需要在不显示私有方法与属性的基础上,在所有“protected:
3、”关键字后加上privatesection命令:protected:/*privatesection*/6. 隐藏其他内容需要隐藏其他内容,可以在要隐藏的内容前后加上cond与endcond命令,如:/condtypedef struct size_t start;int step; / 可以0size_t end;/ 值的个数inline size_t Count() const return int(end-start)/step + 1;/ 位置计算,错误返回0xffffffffinline size_t Index(size_t v) constreturn (v-start)%step=0 ? (v-start)/step : 0xffffffff; Range;/endcond