| 网站首页 | 业界新闻 | 小组 | 威客 | 人才 | 下载频道 | 博客 | 代码贴 | 在线编程 | 编程论坛
欢迎加入我们,一同切磋技术
用户名:   
 
密 码:  
共有 1270 人关注过本帖
标题:今日散分帖,顺便问个程序注释问题。
只看楼主 加入收藏
hellovfp
Rank: 16Rank: 16Rank: 16Rank: 16
等 级:禁止访问
威 望:30
帖 子:2976
专家分:7697
注 册:2009-7-21
收藏
得分:0 
回复 17楼 zhoufeng1988
感谢zhou版主的资料,收藏一下。
唉,至少“每一个变量声明都应该进行注释 [COMMENT-05-3] ”这个偶程序中就没有准循,继续努力。
这条国标 建议不使用单行注释“∥” [GJB5369-4_10_2_2-5] 让偶很纠结。


我们都在路上。。。。。
2011-08-19 13:40
TonyDeng
Rank: 20Rank: 20Rank: 20Rank: 20Rank: 20
等 级:贵宾
威 望:304
帖 子:25859
专家分:48889
注 册:2011-6-22
收藏
得分:0 
不重视注释、不重视格式,是很多初学者的通病,甚至有人以写出别人看不懂的代码为荣的。看看那些总是问for(……);为什么错的问题帖就知道了,答了一次、两次,总不听劝,还辩解说书上就是这么写,那就随他们去吧。

授人以渔,不授人以鱼。
2011-08-19 13:44
TonyDeng
Rank: 20Rank: 20Rank: 20Rank: 20Rank: 20
等 级:贵宾
威 望:304
帖 子:25859
专家分:48889
注 册:2011-6-22
收藏
得分:0 
回复 21楼 hellovfp
规则是死的,人是活的,诸如循环变量ijk之类,也写个注释,那是神经病。

授人以渔,不授人以鱼。
2011-08-19 13:46
hellovfp
Rank: 16Rank: 16Rank: 16Rank: 16
等 级:禁止访问
威 望:30
帖 子:2976
专家分:7697
注 册:2009-7-21
收藏
得分:0 
回复 23楼 TonyDeng
一般i,j,k偶也没有注释,觉得很明了的变量,无须多解释。

我们都在路上。。。。。
2011-08-19 13:51
hellovfp
Rank: 16Rank: 16Rank: 16Rank: 16
等 级:禁止访问
威 望:30
帖 子:2976
专家分:7697
注 册:2009-7-21
收藏
得分:0 
回复 22楼 TonyDeng
没有注释的程序读起来很蛋疼呀,每个初学者都应该一开始就学习编码规范的,不过大多数初学者没有意识到,等意识到的时候,已经形成习惯不写注释了。

我们都在路上。。。。。
2011-08-19 13:54
njkido
Rank: 9Rank: 9Rank: 9
等 级:蜘蛛侠
帖 子:224
专家分:1184
注 册:2011-3-8
收藏
得分:11 
Doxygen 的注释风格不错 还能自动生成注释文档 推荐一下
2011-08-19 13:54
TonyDeng
Rank: 20Rank: 20Rank: 20Rank: 20Rank: 20
等 级:贵宾
威 望:304
帖 子:25859
专家分:48889
注 册:2011-6-22
收藏
得分:0 
连i,j,k这样的纯粹循环变量也注释,就是我前面提到的过分注释。那些文档规范,只可意会,不可死守,关键是理解其精神。

授人以渔,不授人以鱼。
2011-08-19 13:59
hellovfp
Rank: 16Rank: 16Rank: 16Rank: 16
等 级:禁止访问
威 望:30
帖 子:2976
专家分:7697
注 册:2009-7-21
收藏
得分:0 
回复 26楼 njkido
嗯,这个开源工具蛮好的,听说过,还未曾使用,搞一个玩玩去。

我们都在路上。。。。。
2011-08-19 14:00
hellovfp
Rank: 16Rank: 16Rank: 16Rank: 16
等 级:禁止访问
威 望:30
帖 子:2976
专家分:7697
注 册:2009-7-21
收藏
得分:0 
回复 27楼 TonyDeng
如果是变量名能很清楚的表名意图呢?
如程序片段中
   char buffer[BUFSIZ];
        int found = 0;
如果按规定非i,j,k之类的应该注释,但偶却怕过份注释,没有写,有时候看到别人的代码好象也没有注释,有点纠结了。

我们都在路上。。。。。
2011-08-19 14:03
hellovfp
Rank: 16Rank: 16Rank: 16Rank: 16
等 级:禁止访问
威 望:30
帖 子:2976
专家分:7697
注 册:2009-7-21
收藏
得分:0 
还有个问题:如果这样设计函数错误信息设置,是否合理?
程序代码:
#ifndef CERROR_H_INCLUDED
#define CERROR_H_INCLUDED

int g_nerror = -1;

const char *error_msg[] = {
        "invoke ok",            // 0 函数调用成功
        "alloc memory faile",   // 1 内存分配失败
        "string not init",      // 2 字符串未初始化附值
        "string not equal",     // 3 字符串不相等
        "out of index range"    // 4 索引超出范围
};

int             get_last_error(void);        //获取最后一次函数调用错误值
const char *    get_error_msg(int errro);    //获取对应的错误信息

#endif // CERROR_H_INCLUDED




[ 本帖最后由 hellovfp 于 2011-8-19 14:12 编辑 ]

我们都在路上。。。。。
2011-08-19 14:09
快速回复:今日散分帖,顺便问个程序注释问题。
数据加载中...
 
   



关于我们 | 广告合作 | 编程中国 | 清除Cookies | TOP | 手机版

编程中国 版权所有,并保留所有权利。
Powered by Discuz, Processed in 0.081952 second(s), 7 queries.
Copyright©2004-2024, BCCN.NET, All Rights Reserved