Re: [請益] 程式該怎麼越寫越好呢

[WalkingIce ( 殺手哥吉拉 13)]

※ 引述《realmeat (真肉)》之銘言：
: ※ 引述《amppp (Monte-Carlo)》之銘言：
: 我的目標則是
: 程式碼當中不使用到一行註解, 就能讓別人了解你寫的程式
: 要做新的東西, 需要運用原本所寫的功能
: 只要把檔案搬過去就能work, 做到模組化
: 程式寫到現在 感覺只是對不同的資料進行處理
: 看最底層只是 許許多多的指令, 按照自己設計的動作排序好
: 沒有啥需要被證明的
: 對我來說真正的課題 則是在程式碼的可讀性以及可移植上才是重點

最近在看 code 的時候突然有一種經驗

剛好那一份程式碼沒有註解，其實它寫得很好
當我深入下去看的時候大多數都看得懂
只是看完後我會想說：如果他加了一行註解告訴我這段程式碼在幹嘛
或許會讓我看 code 時候更快
就像看報紙的時候，絕大多數的報導只看標題就知道需不需要認真看


前一段時間遇到一個 bug
也因為它是一個 bug，所以整個演算法是有瑕疵的
卻因為它沒有註解，我猜不透它到底是想做行為 A 卻沒做好
或是這段程式碼產生的行為 B 在這個情況下不適用
(也就是說這一小塊程式碼沒錯，但是放到某些條件下使用時就會發生問題)

A 或 B 的修法不一樣，如果選錯了方向
即使現在把 bug 修掉了，也難保未來不會變成一個隱性的 bug

讓我花很多時間的反倒是去猜原作者到底想要的是什麼
這時候就會很感慨：「如果有一行短短的註解就好了～」 :-)

--


                        隨手關電腦，救救北極熊


--
※ 發信站: 批踢踢實業坊(ptt.cc) 
◆ From: 61.57.131.211
→ adrianshum:這種想法我是認同的，可惜大部份人寫的
→ adrianshum:comment 都只是用來解釋程式的 flow
→ adrianshum:而不是如你所說提出重點。
推 ricky906:這樣的comment才值得寫到source code裡..
→ ricky906:code都已經夠長了.額外的註解能免則免..
→ ricky906:我覺得原po需要的應該是一份設計文件
推 yoco315:技術文件+1 問題是 99% 的公司沒這東西 XD
推 softwind:越短的code越需要 doc ... but ...
→ softwind:有台灣公司把doc視為產出嗎?
推 creeds:註解是禮節，或許自己不需要但還是有比沒好