| 网站首页 | 业界新闻 | 小组 | 威客 | 人才 | 下载频道 | 博客 | 代码贴 | 在线编程 | 编程论坛
欢迎加入我们,一同切磋技术
用户名:   
 
密 码:  
共有 1726 人关注过本帖
标题:关于C语言的注释
只看楼主 加入收藏
王璐
Rank: 2
等 级:论坛游民
帖 子:126
专家分:54
注 册:2010-7-26
结帖率:93.1%
收藏
已结贴  问题点数:20 回复次数:7 
关于C语言的注释
C语言的注释有没有什么具体的规则啊
搜索更多相关主题的帖子: C语言 注释 
2010-07-31 12:29
pzwx
Rank: 1
等 级:新手上路
帖 子:3
专家分:2
注 册:2010-7-8
收藏
得分:2 
有两种:
1./*...................*/
可换行写
/*..........
............*/
2.//.............(不可换行写)
2010-07-31 13:00
BJ_BOY
Rank: 4
等 级:业余侠客
威 望:1
帖 子:77
专家分:225
注 册:2010-2-4
收藏
得分:5 
不同的公司有不同的注释要求。
通常注释分为(个人的划分):
1)文件注释:说明一个文件的作用、作者、修改时间、版本等信息。
2)函数注释:说明一个函数的作用、作者、修改时间、版本、参数、返回值等。
3)代码注释:说明一段代码(变量、表达式、语句、语句块)的作用等。

注释要直接、简洁、有效、明了。原则上,越多越好,但过尤不及。
2010-07-31 13:32
BJ_BOY
Rank: 4
等 级:业余侠客
威 望:1
帖 子:77
专家分:225
注 册:2010-2-4
收藏
得分:8 
弄个所谓的水贴吧。

A.2 注释

    2-1:一般情况下,源程序有效注释量必须在20%以上。
    2-2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
    2-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
    2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
    2-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
    2-6:注释的内容要清楚、明了,含义准确,防止注释二义性。
    2-7:避免在注释中使用缩写,特别是非常用缩写。
    2-8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。
    2-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
    2-10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。
   2-11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
   2-12:注释与所描述内容进行同样的缩排。
   2-13:将注释与其上面的代码用空行隔开。
   2-14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。
   2-15:对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。
2010-07-31 13:45
encounter
Rank: 5Rank: 5
来 自:扬州
等 级:职业侠客
威 望:2
帖 子:150
专家分:359
注 册:2010-7-24
收藏
得分:5 
没啥规则,注释有一项比较好,就是可以在里面发泄,明白吗,也许以后会明白。。。。。。。
所谓注释呢
就是写给别人看的
有些东西不写注释还真看不懂
也方便别人找错误
因为呢
又时候,别人感觉你写错了,其实你并不是想干他所想的,也就是你是对的,在当前应试教育下,有很多人就会找到这些“错误”
还有呢,就是你真的错了,别人没能明白你在干嘛,比较保守的人就会将它放行
所以得,必要的时候,还是打点中文,有助于别人明白你的大作


ping   nbtstat   netstat   tracert    nat   at    ftp   telnet..................
2010-07-31 16:56
BlueGuy
Rank: 16Rank: 16Rank: 16Rank: 16
等 级:版主
威 望:29
帖 子:4476
专家分:4055
注 册:2009-4-18
收藏
得分:0 
从不写注释, 哥写的代码堪比注释。/

我就是真命天子,顺我者生,逆我者死!
2010-07-31 18:41
王璐
Rank: 2
等 级:论坛游民
帖 子:126
专家分:54
注 册:2010-7-26
收藏
得分:0 
看来您的代码都很简单易懂的哦。。。
2010-07-31 18:56
不归鹄
Rank: 9Rank: 9Rank: 9
来 自:冥王星
等 级:蜘蛛侠
威 望:4
帖 子:491
专家分:1380
注 册:2009-12-20
收藏
得分:0 
回复 7楼 王璐
你要知道,6楼的那位老伯可不是一般的厉害

2010-08-09 21:54
快速回复:关于C语言的注释
数据加载中...
 
   



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

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