Re: [闲聊] 写code不加注解真的很顾人怨吗 strlen PTT批踢踢实业坊

Re: [闲聊] 写code不加注解真的很顾人怨吗

楼主: strlen (strlen) 2024-12-25 20:51:38

※ 引述《ianlin1216 (伊恩可可)》之铭言：
: 实务上遇到这种情况真的很赌烂吗
: 干五西恰
最好的作法是
尽量把程式写得清楚简单易懂好理解
这样就不需要加注解了
注解是拿来用在解释特殊情况
也就是
当某段程式你怎么样也没办法直接用程式码解释
这时候你再去下注解
所以理想状况是
注解应该要非常少甚至完全没有（小一点的系统
理由很简单
注解也是要维护
很多人修bug都忙死了
哪来美国时间跟你改注解？
不然就忘东忘西
这边修一下那边调一下
协作时可能还不只一个人在改同个地方
时间一久注解就忘了更新
过时的注解比没有注解还要来得糟糕
因为反而会误导别人
然后整个团队太多人被注解骗惹
越来越不信任注解
最后就干脆整个无视
但又不晓得该不该删掉
久了就变成技术债
碍眼的垃圾
但你又不敢动它...............
至于
怎么把程式写得清楚简单易懂
这就是功力问题
呵

作者: ren740719 (雪月灿) 2024-12-25 20:56:00

就很多人自己为自己写得清楚简单易懂，殊不知下个接手专案的，看到只想问候前任的老目

作者: Wardyal (Wardyal) 2024-12-25 20:57:00

我看Clean Code也是推荐注解越少越好

作者: jeff666 2024-12-25 21:00:00

我有自知之明写得很烂乖乖写注解

作者: ssarc (ftb) 2024-12-25 21:01:00

就是上备注嘛，不管做什么工作都需要上备注，有些备注好有些备注烂

作者: XFarter (劈哩啪啦碰碰碰) 2024-12-25 21:02:00

https://www.reddit.com/r/learnprogramming/s/ivot6CreKP只能说做法各有千秋但很多细部行为只靠着变量名称去解释其实蛮困难的

作者: spfy (spfy) 2024-12-25 21:09:00

Clean Code写的和实做差很多阿人月神话一堆人看过但业界还不是用陨石开发法+10个妈妈怀胎1个月但也是有任天堂这种做的比教科书好还自己开发工具的奇蹟我现在会用AI测试帮我加注解和重新命名如果它给的建议很烂表示你扣写的很烂他没办法判断这还满有用的