- 积分
- 5172
- 明经币
- 个
- 注册时间
- 2003-4-18
- 在线时间
- 小时
- 威望
-
- 金钱
- 个
- 贡献
-
- 激情
-
|
发表于 2005-2-22 13:26:00
|
显示全部楼层
讚!
注释和测试代码都齐全.
如果能用开源项目都统一的注释更好,举例如下:
1.变量
/** . **/ double m_a;
2.函数
/** * @brief . * * @param * @param * @return * @pre * @post **/
3.文件头
/** * Copyright (C), 2004-2005, www.mjtd.com. * FileName: %FILE_BASE%.%FILE_EXT% * Description: ? * Version: 1.0 * Author: * Date: %DATE% * History: * <author> <time> <version> <desc> * %DATE% 1.0 Bulid this class **/
如果用以上的注释,利用Doxygen工具(一个开源项目)可以自动生成文档,非常方便,推荐给你. |
|