作者Ghamu (猫丸)
看板Soft_Job
标题Re: [请益] 写注解到底是不是好习惯
时间Sat Dec 29 04:36:59 2018
个人浅见
注解是可耻的
代表你程式不够乾净
变数 函式名称词不达意 只能靠注解补完
最近手上接到外包的程式码
有一个核心处理封包差不多200行程式码
里面做什麽呢？
他有好心写上注解
//处理messages类型 A
.
.
.
//处理类型B
.
.
.
//..............C
欸.....
那实际上不就该是
处理类型A();
处理类型B();
处理类型C();
吗？？？
当注解变多时 或开始写注解时
就是一个该refactoring的信号了
当然说可耻是有点偏激
主重点在於说应该尽力穷尽所能
让程式码即注解
而不是去依赖注解
注解虽然可耻 但是有用
在以下情形我还是会注解
1.英文不够好
有时候想不到该怎麽描述才清楚
毕竟不是英文母语
只好写上注解 等未来有缘人帮忙修改
2.变数名称 函式因为单字太长
冷僻缩写 我会加上注解 别让下一个人猜
3. 非正规解法 诡异做法时
最近刚好遇到Java rename 会失败的问题
一位资深的前辈说是因为里面一连串动作
有一个错他就整个错
建议把他拆开来做 先复制 改名 move 等等
如果自己写一个rename ()
把这些步骤放进去
下一个人看到
一定会疑惑为什麽要自己重写吧？
这时候就要加上注解描述是因为有那个风险
才做此改变
简单的说
程式码就是注解
注解不要重复描述程式码
注解要能提供程式码以外 你的设计意图
-----
Sent from JPTT on my Sony F5321.
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 114.25.229.193
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1546029421.A.35E.html
1F：推 orange0319: 认同 12/29 09:09
2F：推 Ryuusei: 推一个，我也是只有在程式码本身不足以表达全部资讯的时 12/29 09:18
3F：→ Ryuusei: 候才写注解 12/29 09:18
4F：推 Angesi: 等你要离职时 你会後悔写了注解... 12/29 10:09
5F：推 cookie1115: 推 12/29 13:01
6F：嘘 darkMood: 笑死，你到底知不知道什麽时候该写注解? 12/29 21:50
7F：→ darkMood: 注解的价值和你的废文无关，不会写注解不要牵拖注解不好 12/29 21:51
8F：推 bitcch: 3在很多lib里面很常见 还有上面在气什麽 12/30 05:28
9F：→ leolarrel: 大家都在理性讨论,darkMood 在悲愤啥?? 12/30 14:02
10F：推 ku72: 推~ 01/05 09:16