积极答复者
头文件加了函数参数注释,cpp文件还需要加函数参数注释吗?

问题
-
现在我有一个疑惑:
头文件加了函数参数注释,cpp文件还需要加函数参数注释吗?
比如,在头文件声明:
// 头文件声明 /*! \brief 两数相加 \param nLeftNum 左操作数 \param nRightNum 右操作数 \return 两数相加结果 */ long Add(int nLeftNum,int nRightNum);
是否还要再cpp文件添加:
// cpp文件实现 /*! \brief 两数相加 \param nLeftNum 左操作数 \param nRightNum 右操作数 \return 两数相加结果 */ long Add(int nLeftNum,int nRightNum) { ...... }
我的看法是头文件肯定是要添加函数参数注释的,因为毕竟要提供给别人接口,就是给别人看的。开始我认为在cpp文件中不需要添加函数参数注释,但是后来我想以后的代码维护人员也需要看的吧,难道要别人翻到头文件来看吗?
大家对此的看法是怎样的呢?
前无古人,后无来者
答案
-
-
一般比较正规的代码是头文件加函数介绍和参数的注释,源文件在代码里面加代码的注释
0xBAADF00D- 已标记为答案 Allen Chen - MSFTModerator 2009年12月28日 9:21
-
在cpp里面写注释是为了给以后自己或者别人看你代码方便用的。如果考虑纯粹的ADT,则只在类的(函数)声明那里写注释即可。
bylh- 已标记为答案 Allen Chen - MSFTModerator 2009年12月28日 9:21
全部回复
-
-
一般比较正规的代码是头文件加函数介绍和参数的注释,源文件在代码里面加代码的注释
0xBAADF00D- 已标记为答案 Allen Chen - MSFTModerator 2009年12月28日 9:21
-
在cpp里面写注释是为了给以后自己或者别人看你代码方便用的。如果考虑纯粹的ADT,则只在类的(函数)声明那里写注释即可。
bylh- 已标记为答案 Allen Chen - MSFTModerator 2009年12月28日 9:21