程序员写代码一定要写注释吗?好的代码注释是怎样的?

萌新提问:一个月前自己写的代码,我也忘了是什么意思。
啊!代码千万行,注释第一行;编码不规范,回看两行泪!
大学时候写码的确是行行写注释,但是呢,debug 的时候太不直观了…
刚翻了一下程序员宝典——《代码大全》,果断放弃,我决定来请教一下各位大神:
你们平时写代码都会写注释吗?好的代码注释应该是怎样的?

回答·259
最热
最新
  • 注释???不存在的 不写注释才能让公司离不开我
  • 代码优雅不用注释 我要纠正你一个错误观念:Debug 看注释 注释不是给你 Debug 的时候看的,Debug 打的是断点,看的是变量、数值、地址、如果你要调试,别看注释。看了也看不出什么东西。 注释的目的是为了帮助浮动代码,并不是必要的。有很多东西没必要特地注释,比如 a = inputx b = inputy a,b = b,a 这种简单的交换写法,特地写注释才是有问题(我怀疑你是看不起我?) 又或者, /*显示使用提示*/ //上边注释的这位,请去天坛医院看看脑神经外科 printf('欢迎使用本系统'); 一般都是看的模棱两可的地方或者需要说明的地方才需要注释 # 从 func 加入计算 abc 的内容,输出后与 t 做比较 result = fun(a1,b1,c1).cmp(t) 只有写代码的人才有资格和理由决定是否应该加注释。代码优雅的地方,没有注释也无所谓,过度注释小心被说你摸鱼哦~ 不过,如果在应该加注释的地方没有加,比如 t = a + ++b - c-- -b++; 那就是找抽了吧~ 当然,平时特别需要说明或者调侃的地方也可以加注释,但是你要记住,你的注释大家都会被看到: //老板说了,客户不给钱,不给注释下面这行 sleep(20) //xxx 因为传播负能量信息已经被辞退,请大家认真注释,不要影响团队情绪 大概就是这样吧
  • 当一个人突然开始写详细的注释,代表他想离开公司了
  • 1,逻辑性很强,写的像疯狗,必须加 2,逻辑性很强,代码很精简,可以加 3,逻辑性不强,写的像疯狗,必须加 4,逻辑性不强,写的很精简,可不加 如果语文不好,注释写完了自己一定要审一遍,避免误导别人。
  • 一般人的注释跟他代码一样  也只有他自己才看得懂!
  • 好的代码本身就是注释
  • 一边代码一边注释是好的习惯,但是一般熟练的不会,影响操作时间
  • 没注释不叫代码 注释能很好的让其他同事理解代码含义,俗话说前人栽树后人乘凉
  • 上个月写了点代码,当时只有我跟上帝知道它是干什么的,今天看了看代码,只有上帝知道它是干什么的了; 我认为好的代码注释需要写清楚他是干什么的 参数返回值 都应该写明白 如果有什么一直问题应该也要写出来 所以最开始的版本到改完 bug 之后的版本 改动的地方 应该也要写明白,防止来个新人觉得 哎哟 这个代码写的不 fashion 最后改完了改出当年你早就调过的 bug
  • 我写代码时,习惯写注释,至少每个函数写个注释说明,方便以后自己看或别人看时,能够很快明白函数的作用。 可以一个函数写一个注释,也可以每一行功能代码写个注释,看个人习惯吧