程序员代码注释规范

写注释如果方法不对,是比没写还恶劣的行为!

我想到的,常见的情况有:

1. 注释不规范或过度注释

随意的,到处都是注释,有用没用的都写,比如:

a = 1; // 给 a 赋值为1

谁还看不懂 a=1 是做啥么...

2. 注释不维护

业务变化比较快的系统,需要连续不断的开发,你要一直对它做维护性质的开发,有时候要不断的修改代码以适应业务的变化。这时候问题就来了。。

比如某个函数一开始是做A这件事,第一个人为这个函数写了注释是A,后来业务变化,第二个人把这个函数改成做B这件事了,然后测试通过,没问题了。此时注释还是A. 后来第三个人改成了做C,注释仍然是A。

函数的功能可测,但是注释不可测,注释需要人的维护,如果不维护简直就是噩梦。

假设有第四个人过来读代码,看到注释都是A的内容,他是不是会一头雾水呢?

有些注释,有人认为很有用,但我觉得在这种场景下不一定。

比如有人喜欢 @author xxx 在函数或者类的前边标记自己的大名,我就觉得这个做法在多人、业务变化的开发场景下,很鸡肋。通常人家把你的代码改得面目全非了,看作者还是你,今后出了问题,后来人诅咒的是你这个 author 啊....

3. 代码只注释,不删除

很多人写代码总有这种习惯,一段代码不用了,注释掉,心里总想着这段代码以后可能还会用。但大多数情况下,过几天就忘了,结果代码里到处都是“注释”,没有一句是有用的。读代码的人也不敢删,一直留着留着。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,448评论 25 707
  • 原文: https://github.com/ecomfe/spec/blob/master/javascript...
    zock阅读 3,370评论 2 36
  • 繁华落尽,一似食尽鸟投林,往昔岁月虽历历在目,奈何天,良辰美景随风化,赏心乐事换新颜! 悲金悼玉的红楼梦,虽不曾歌...
    kellylzj阅读 232评论 0 1
  • 今天翻朋友圈看到朋友的新状态,想到他坚持一万小时的壮举,心里有好些惭愧。很多时候,很多事情,不逼自己一把永远不知道...
    Miss_Mia阅读 148评论 0 0