Re: [请益] 写注解到底是不是好习惯

楼主: keke0421 (zrae)   2018-12-29 11:42:19
这问题的背后是没有答案
但我们可以根据目前世界一流的repo 来参考
绝大部分的世界级的framework 包含 linux
专案里面都一定会有注解 只是注解多 或 注解少
其中让我最喜欢的 专案大概是 laravel 连注解都写得很艺术
我自己是赞成部分写注解 而且要写清楚
当专案架构越来越大 开发的人越来越多
尤其是 -> 功能越加越多
上头 随便天马行空就来一笔 OOXX 的需求
( X的!当初为什么不讲,现在要怎么弄 )
不太可能没有技术债的产生
有时候因为时程关系 / 前人留下的技术债 / 上头的天马行空的新需求
有些地方是牵一发动全身
虽然明知道最好的办法是 某feature全部打掉重练 但是 整个重写至少2个礼拜
照现在的逻辑下去写 2个小时 以先解决的目前的ticket目的的前提
会让你陷入一个 就算名称取再好
你也无法讲述清楚的情况
所以这时候写注解 可以省去后来维护的人 或 几个月的自己
方便快速地进入状况
这时候 我是赞同写注解
非此情况下的注解 我会比较希望看到 整个全局的概述 而非 单个block的论述
作者: anandydy529 (AndyAWD)   2018-12-29 12:32:00
我接手过某个专案,上面就写过2018/02/13 OOO要求加入这功能,//2018/05/04 XXX要求删除该功能我接手后AAA又跑来跟我说OOO要再把功能加回去,这时后就只能找上面三个来打一架了
作者: MOONY135 (谈无欲)   2018-12-29 13:09:00
觉得都是经常会遇到的状况 哈哈哈
作者: xam (听说)   2018-12-29 13:25:00
其实上面讲的东西应该是 commit log 该有的.
作者: vn509942 (如履薄冰)   2018-12-29 13:34:00
看新的issue 的时候 如果有注解会比较容易清楚状况
作者: peanut97 (丁丁)   2018-12-29 21:30:00
作者: viper9709 (阿达)   2017-01-01 23:23:00
推这篇

Links booklink

Contact Us: admin [ a t ] ucptt.com