首页
社区
课程
招聘
编码、脱壳时写注释建议
发表于: 2004-11-28 16:22 8156

编码、脱壳时写注释建议

2004-11-28 16:22
8156
从高质量C++编程上看到的,很有用。

        【规则2-7-1】注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。注释的花样要少。
        【规则2-7-2】如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。例如
i++;         // i 加 1,多余的注释
        【规则2-7-3】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
        【规则2-7-4】注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。
        【规则2-7-5】尽量避免在注释中使用缩写,特别是不常用缩写。
        【规则2-7-6】注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方。
        【规则2-7-8】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。

[课程]FART 脱壳王!加量不加价!FART作者讲授!

收藏
免费 1
支持
分享
最新回复 (18)
雪    币: 846
活跃值: (221)
能力值: (RANK:570 )
在线值:
发帖
回帖
粉丝
2
消灭0回复~~
2008-11-25 11:41
0
雪    币: 8209
活跃值: (4458)
能力值: ( LV15,RANK:2459 )
在线值:
发帖
回帖
粉丝
3
【规则2-7-7】如果是发哥都看不懂的代码,则不必加注释。
2008-11-25 11:50
0
雪    币: 242
活跃值: (418)
能力值: ( LV11,RANK:188 )
在线值:
发帖
回帖
粉丝
4
【规则2-7-9】如果是C哥都看不懂的代码,则不必发注释以外的东西。
2008-11-25 12:05
0
雪    币: 6075
活跃值: (2236)
能力值: (RANK:1060 )
在线值:
发帖
回帖
粉丝
5
相隔4年也可以回复?
2008-11-25 15:03
0
雪    币: 398
活跃值: (343)
能力值: (RANK:650 )
在线值:
发帖
回帖
粉丝
6
[I]此帖于 2008-11-25 15:46 被 shoooo 编辑. [/I]

[I]此帖于 2008-11-25 15:47 被 shoooo 编辑. [/I]

[I]此帖于 2008-11-25 15:48 被 shoooo 编辑. [/I]

[I]此帖于 2008-11-25 15:49 被 shoooo 编辑. [/I]

[I]此帖于 2008-11-25 15:50 被 shoooo 编辑. [/I]

[I]此帖于 2008-11-25 15:51 被 shoooo 编辑. [/I]

[I]此帖于 2008-11-25 15:52 被 shoooo 编辑. [/I]

[I]此帖于 2008-11-25 15:53 被 shoooo 编辑. [/I]

[I]此帖于 2008-11-25 15:54 被 shoooo 编辑. [/I]

[I]此帖于 2008-11-25 15:55 被 shoooo 编辑. [/I]
2008-11-25 15:09
0
雪    币: 2316
活跃值: (129)
能力值: (RANK:410 )
在线值:
发帖
回帖
粉丝
7
晕,那时fg很年轻。
2008-11-25 16:20
0
雪    币: 7309
活跃值: (3778)
能力值: (RANK:1130 )
在线值:
发帖
回帖
粉丝
8
他 是 版 主
2008-11-25 17:42
0
雪    币: 111
活跃值: (10)
能力值: ( LV4,RANK:50 )
在线值:
发帖
回帖
粉丝
9
原来如此。。
2008-11-25 18:20
0
雪    币: 224
活跃值: (147)
能力值: ( LV9,RANK:970 )
在线值:
发帖
回帖
粉丝
10
fg也搞起C来了...
2008-11-25 18:29
0
雪    币: 590
活跃值: (177)
能力值: ( LV9,RANK:680 )
在线值:
发帖
回帖
粉丝
11
说的很有道理
有同感~~
2008-11-25 20:40
0
雪    币: 8209
活跃值: (4458)
能力值: ( LV15,RANK:2459 )
在线值:
发帖
回帖
粉丝
12
四年前发哥都不用C的,就开始忽悠人了
2008-11-25 22:11
0
雪    币: 417
活跃值: (475)
能力值: ( LV9,RANK:1250 )
在线值:
发帖
回帖
粉丝
13
膜拜 ............................
2008-11-26 07:46
0
雪    币: 513
活跃值: (2258)
能力值: ( LV9,RANK:2130 )
在线值:
发帖
回帖
粉丝
14
..这么老的贴,锁了先,没必要再炒了
2008-11-26 08:52
0
雪    币: 331
活跃值: (56)
能力值: ( LV13,RANK:410 )
在线值:
发帖
回帖
粉丝
15
挖穿地球
123456
2008-11-26 10:10
0
雪    币: 192
活跃值: (10)
能力值: ( LV4,RANK:50 )
在线值:
发帖
回帖
粉丝
16
哇,顶起乾隆贴,很强大啊ORZ
2008-11-26 11:49
0
雪    币: 690
活跃值: (1821)
能力值: ( LV9,RANK:250 )
在线值:
发帖
回帖
粉丝
17
四年前的帖子,差点以为论坛服务器的时钟出毛病了.
2008-11-26 12:23
0
雪    币: 6075
活跃值: (2236)
能力值: (RANK:1060 )
在线值:
发帖
回帖
粉丝
18
被月光宝盒照到了
2008-11-26 15:02
0
雪    币: 231
活跃值: (10)
能力值: ( LV2,RANK:10 )
在线值:
发帖
回帖
粉丝
19
O(∩_∩)O哈哈~  一个旧帖  引出了这么多牛人  
也来膜拜F哥和c哥
2008-11-27 13:39
0
游客
登录 | 注册 方可回帖
返回
//