楼主:
sec5566 (sec)
2018-12-27 13:48:31以前上课跟书本都提到写注解，
但是我看资深同事还有接手的程式码，
都没有注解，只有我在写，
还被主管念过写注解没必要，
命名好就够了，
是我观念落伍了吗？
作者: t64141 (榕树) 2018-12-27 13:54:00
想不写注解有很多前提，而这个前提不容易达到
作者:
oneheat (等待)
2018-12-27 13:55:00好的代码很少在写注解，或者说，code都写不好了，为什么会觉得注解会写的好呢？
有写注解让其他人比较省时吧 五六行的程式 一句注解就知道在干嘛了 有时候哪有时间在那边一行一行看
作者:
deray (Deray)
2018-12-27 14:11:00写什么注解？贴一段来看一下为什么需要注解
作者:
yyc1217 (somo)
2018-12-27 14:12:00觉得自己写的很好就不写注解 这种人很有问题觉得自己写得不好而写一堆注解 这种人也很有问题
作者:
iiiii (I take 5)
2018-12-27 14:14:00写SAMPLE CODE一样道理，曲高和寡，不是人人懂你的pattern
作者:
yyc1217 (somo)
2018-12-27 14:15:00注解是写给三个月后的自己看的
不过这样讨论都打高空啦 除非你贴一段被念的程式跟注解
git log是很好用的东西，每个人都在程式码内注解一段，那到底是要看程式还是看注解
作者:
femlro (母猪教谋神异端审问官1.5)
2018-12-27 14:32:00苹果官方的code都有注解了 不写注解超越苹果
作者:
deray (Deray)
2018-12-27 14:35:00注解！=文件
我觉得至少在func/cls开头简单地写一行这是拿来干嘛
我是会在比较复杂的判断上写注解，以后看比较不用思考
作者: hotdogmc (陈全) 2018-12-27 14:47:00
程式码本身就是注解
作者:
Argos (Big doge is watching u)
2018-12-27 14:48:00要看情况阿 你是要出API 没注解行么？ XD
作者:
Argos (Big doge is watching u)
2018-12-27 14:49:00内部产品程式 注解有必要再加吧 有些潜规则不讲很麻烦
自以为写很好不用写注解的很多+1 通常就是...自以为
拜托要+1命名到为还是需要注解 因为每个人逻辑不一样
作者:
deray (Deray)
2018-12-27 15:20:00“当程式码与注解不符时，你相信什么？”“The ultimate comment for the code is the code itself“注解是用来‘弥补我们用程式码表达意图的失败’”
作者:
knives 2018-12-27 15:21:00推楼上加一，商业逻辑可以另外写在文件上去交接
作者: dnabossking (少狂) 2018-12-27 15:42:00
把code写的烂的一b然后跟你说：“我有写注解”看完注解再看code发现注解根本在误导（你根本没有任何方法保证注解的正确性跟易懂）这种人我也见过不少就是了
作者:
exeex (执行档EX)
2018-12-27 16:05:00先养成"程式即是注解"的code style
作者:
iamshiao (CircleHsiao)
2018-12-27 16:15:00特殊处理写，其他不写
作者:
kevin28 (嗯？)
2018-12-27 16:18:00比较复杂的逻辑才会写
作者:
sean50301 ( (づ′・ω・）づ)
2018-12-27 16:44:00看情境xd 建dl模型注解一下shape 后面的人会很感谢你
作者:
KanoLoa (卡)
2018-12-27 17:06:00当然要写阿，写个magic搞搞后人
要拜托 文件也要写一下不然看到A05_001.java 这样的没注解没文件鬼才知道是要做啥的
至少函式要写注解说明功能 和input/output吧
作者:
ekin1983 (BBBBBBBBBBBBB)
2018-12-27 17:19:00我的注解通常只写什么时间 为何而改(bug 资安 需求单)还有每个function上方注明用途
个人觉得都可以 不管写不写注解 只要你的code让人不好懂 那就有改进的空间 不管是加注解或是重构
作者: PoloHuang (黄保罗) 2018-12-27 18:03:00
写了注解 结果之后程式有改结果注解没跟着改
只有复杂的逻辑 或 work around的部分会写而已
作者:
testPtt (测试)
2018-12-27 18:52:00注解写得好下次回来改东西就很好进入状况
那有做 code review 吗？有确保不解说的情况下对方能看懂吗？
作者:
testPtt (测试)
2018-12-27 18:59:00尤其像C#注解还有函式超连结功能 追程式码方便很多
作者: codehard 2018-12-27 19:19:00
可以写pseudo code当注解
作者:
overhead (overhead)
2018-12-27 19:53:00注解是用来‘弥补我们用程式码表达意图的失败
你把code贴上来，不然会沦为各说各话我有看过code写得还行购简洁，可是注解写好几行的(然后还是很整齐)
菜逼巴CODE都写不好了还不写注解 多可怜 没看过大专案?
作者:
gino0717 (gino0717)
2018-12-27 21:22:00注解应该写中文还英文 写英文英文太烂人家看不懂怎么办
要写技术文件，注解还好，code 架构写得好就够了
作者:
chuegou (chuegou)
2018-12-27 21:36:00前辈写得asm没注解 看到快疯掉尤其硬件相依的设计 没注解我甚至该问ME还是EE都不知道
作者:
justben (BEN)
2018-12-27 23:12:00有magic number 的时候 再写就好了XDD
作者:
xxtuoo (浪费时间不好QQ)
2018-12-27 23:36:00几乎全部专案都我一个人维护的..写屁Zzz
作者:
y3k (激流を制するは静水)
2018-12-27 23:42:00不管Code还是注解 有必要才写 有必要必写
作者:
molopo (mmm)
2018-12-27 23:44:00你不写 你同事也不写 可以公告一下你哪间公司吗 未来不想去
作者:
lausai (恨怨悲苦憎怒嗔)
2018-12-28 00:26:00注解是需要的 不过注解的用处是说明程式码作了什么 为什么这么作 而不是怎么做不过觉得助解不需要的主管...不块陶吗XD
作者:
gino0717 (gino0717)
2018-12-28 00:35:00如果当上主管就可以说 自己的code是clean code 不用注解你们底下基层都是dirty code 都给我写好写满
我比较少写这段程式码是干嘛的，但会写为什么要这么做注解要写到到如何见仁见智，但有些写法我不敢苟同...像是说要写注解好维护，写一大堆，结果注解没好好维护或著写Log时，上行来个//Log，return来个//return然后最近对于一个class里有满满的regin感到很不耐烦
看公司环境，很多时候写注解commit log是纪录口头沟通的事（避免未来被阴）
regin==>region才对像是field和property包一个，public method包一个private method又包一个，method里可能验证包一个，实作又一个，实作里面，可能又是情况包好几个region...
注解不是通常都拿来写FIXME: 和WORKAROUND:拿来注释未解决的问题与等有空再回来解0.0
作者:
kinda (天天)
2018-12-28 01:25:00如果写的注解能帮其他人省时间就写。地雷、reference90% 的 code 不需要写。有时间写还不如多整理几次改注解写太多的 code 很痛苦。注解改完还要检查很多次...
作者:
bitcch (必可取)
2018-12-28 01:39:00最好的程式码为程式即是注解 去读读code complete就知道了
作者:
kaltu (ka)
2018-12-28 05:27:00可读性越低的语言越需要注解ASM每个block注解很常见Python本身就是可执行的虚拟码，注解远比doc string少见
作者:
bill0205 (善良的小孩没人爱)
2018-12-28 06:41:00通常只会在写这个function拿来干嘛 或是这个档案的功能
跟可读性没什么关系..程式即是注解?程式码都看完了还需要看注解吗
作者:
jack0204 (Jarbar王朝)
2018-12-28 09:30:00有时候你会看到很神奇的写法在里面，还会觉得逻辑很怪这种不写注解根本不知道它是修了什么鬼东西才在里面的
作者: shellback (shellback) 2018-12-28 09:36:00
我是觉得在比较难懂的地方写一两行注解有好无坏
作者:
final01 (牛顿运动定律)
2018-12-28 09:45:00会问这问题就是只会写很废的注解吧？
话说我有看过每一行function call都写注解的
作者:
Ekmund (是一只小叔)
2018-12-28 14:48:00有规范的注解才是好注解 跟log、版本更新资讯一样
作者:
ggttoo (中华队加油!!!)
2018-12-28 18:51:00还是需要，不需要就不会有这个功能给你写了，重点会不会写
有些hard code的东西不写注解 谁知道那3小意思注解就是个辅助工具 该用则用 不该用则不用没有好不好 而是有没有用对地方就跟if 一样 看过七八层的if 看了只想翻脸但也不能说用if不对 而是乱用用到没水准若真的需要用到七八层if也没啥不对 但有些只要2层
作者:
TAKADO (朕没给的你不能抢)
2018-12-29 17:13:00注解当然是写给3个月后的自己看R
作者:
mido (米豆)
2018-12-29 19:12:00不写注解 你以为你看得懂5.6年前自己写了三小吗
作者:
rahit (水元素)
2018-12-29 23:46:00我一般就每个function说一下在干嘛就好写的比较复杂的部份才会特别加而且常常自己写的过几个月自己也看不懂注解至少让我找得到哪里要改
作者: superpandal 2018-12-30 21:13:00
取决于你东西写的好不好 注解、文档写不好那干脆不要写 程式码写不好干脆不要写...? 阿 不是 是打掉重练喜欢写大而全代码风格的喜欢用注解来维持代码可读喜欢用写小而精风格代码的喜欢用简洁易懂风格来维持代码可读性
当你需要在数分钟内解bug，你会感激自己半年前的注解解
作者: lnmlee 2018-12-31 12:28:00
这总讨战文时不时就会出现