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

楼主: supermmi (陈敏宪)   2018-12-29 12:15:41
我觉得要定义注解内容是什么
如果只是描述程式语法架构本身的东西,不是那么重要
但是有些注解是说明为什么要写这行
原因与程式码本身语法无关
比如注解:这行可暂时避免每一百次会出现一次硬件当机的问题…
又或是:这行是为了满足a厂商的规格…
还有,人都有失忆症,你的程式码很复杂时,注解可以让你过了一年再review时大幅缩短时

然后如果是多人一起开发的大型软件需要整合,都不写注解,那就不是整合是整人了,当然
可以写一份api说明文件取代注解…
以前有听过国外大型软件公司, 要求工程师写的程式码注解字数一定要占档案10%以上,还
用工具去自动检查有没10%…
※ 引述 《sec5566 (sec)》 之铭言:
: 标题: [请益] 写注解到底是不是好习惯
: 时间: Thu Dec 27 13:48:31 2018
:  
:  
: 以前上课跟书本都提到写注解,
: 但是我看资深同事还有接手的程式码,
: 都没有注解,只有我在写,
: 还被主管念过写注解没必要,
: 命名好就够了,
: 是我观念落伍了吗?
:  
:
作者: ThxThx (洗洗睡)   2018-12-29 14:57:00
同意这篇。这个问题Reddit也有许多讨论,像这篇https://www.reddit.com/9m6ahs还有它附的原文 http://antirez.com/news/124
作者: viper9709 (阿达)   2017-01-01 23:35:00
推整人

Links booklink

Contact Us: admin [ a t ] ucptt.com