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