作者hidog (.....)
看板Soft_Job
标题Re: [请益] 写注解到底是不是好习惯
时间Thu Dec 27 17:38:16 2018
※ 引述《sec5566 (sec)》之铭言：
: 以前上课跟书本都提到写注解，
: 但是我看资深同事还有接手的程式码，
: 都没有注解，只有我在写，
: 还被主管念过写注解没必要，
: 命名好就够了，
: 是我观念落伍了吗？
有一派看法是code写的简洁易读,靠命名就能知道作用,
写太多注解没好处. (因为注解也是需要维护的)
有一种例外
当code充斥大量work around的时候,一定要加注解,避免後面维护的人踩地雷
有些work around你不写注解,真的没人看得懂.
建议是先看你的工作环境
如果你的专案维护都有给足够的时间开发,会定期重构,阅读性不差,
也有写unit test等等,这种情况下我同意没必要写注解.
反之,就快逃吧.....
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 118.160.97.186
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1545903498.A.601.html
1F：推 KanzakiHAria: 我从来不信命名就能知道作用 程式包含流程逻辑 12/27 18:05
2F：→ KanzakiHAria: 不写谁知道用三小逻辑去架构的 12/27 18:05
3F：→ hidog: 见仁见智罗 我是偏向不管怎样 写个简单的注解帮助後人维护 12/27 18:13
4F：→ windlll: 自己不管怎样都会写一下，怕接手的人拿刀来砍我XDDDDD 12/27 18:15
5F：推 fukinhot: 不写注解 写文件 12/27 18:21
6F：→ fukinhot: 或是commit message写完整一点 12/27 18:22
7F：推 wotupset: 写注解就像文言文的注疏 写得好可以永世流传 12/27 18:52
8F：→ wotupset: 但没有人会给白话文写注疏 因为年代不同 语言结构改良 12/27 18:53
9F：→ wotupset: 起承转合写得好 自然不用写注解 12/27 18:54
10F：推 twntwn: 程式码只能表达 做了什麽 不能表达 为什麽做 12/27 19:44
11F：→ MOONY135: 写注解我都当作功德... 12/27 20:09
12F：推 oneheat: 接口会写用法跟说明，历史因缘更多应该写在commit log中 12/27 20:37
13F：→ shortoneal: 也有遇过改code改逻辑不改注解的，看的时候黑人问号 12/27 20:41
14F：→ THEWORLDS: 命名可以看得出来就很简单阿 小专案 没啥设计模式在 12/27 20:54
15F：→ THEWORLDS: 你叫学生专案写注解大家都黑人问号拉 这不用辩了 12/27 20:54
16F：推 maxumin: 我是一定写注解，commit log对新接手，帮助的不大，历史 12/27 21:16
17F：→ maxumin: 两百份，追到死还追错，全域变数东西南北都有也是辛苦啊 12/27 21:16
18F：推 acer1832a: 我不排斥写注解，但很讨厌每一行都要写注解才看得懂的 12/28 08:51
19F：→ acer1832a: 人 12/28 08:51
20F：→ rofellosx: 先别说让人接手 自己写的三个月後还能看懂再说.. 12/28 09:32
21F：→ viper9709: 推一楼 12/29 01:36
22F：→ TAKADO: 个人觉得最恐怖的是盲目相信 “code本身就是注解”+”每个 12/29 17:17
23F：→ TAKADO: class/method不可以超过N行” 的教徒写来的东西。 12/29 17:17