Re: [心得] 學好程式設計的訣竅

[snoopy0907 (超強氣)]

※ 引述《TeaEEE (ECFA內容不明  毛毛的)》之銘言：
: 因為手癢回了一段話，想想把一些心得也整理出來，當然每個人的學習方法可能有所不同
: 若有不同學習方式也歡迎分享
: ※ 引述《chessjim (jim)》之銘言：
: : 學好程式設計的訣竅
: : 1盡量把課本內容註解到code中
: 學校老師授課可能會教寫程式寫註解是好習慣，但我會建議不要寫註解，也避免看註解。
: 不知道您是否有看過金庸的一本小說，俠客行，故事中一位武林高手將其絕學隱於俠客行
: 的詩中，並透過大量的註解誤導眾多武林高手耗費數十年的精力而不可得的故事。
: 現實的生活可能不會有這麼壞心的人故意寫"假"註解來騙人(可能要離職前會幹這種事嗎，
: =.=")，但過多或多餘的程式註解，常會影響到我們對原始程式碼的理解，一個最常發生的
: 例子是當程式碼修正時，註解可能未更新，年代久遠後就會造成資訊上的落差。所以與其
: 花心思在寫/讀註解上頭，不如一開始就把程式寫好，學習直接閱讀原始的程式碼。

這部分我稍微持跟您不一樣的看法,也是之前的RD教我的
還是要保持寫註解是好習慣,至少重點的程式碼一定要寫
誰能保證幾個月後或幾年後你再次看這個程式時時還能懂呢?
自己的小程式就算了 但實際的工作狀況是通常BOSS馬上會要你修改程式碼
之前的人沒寫註解的話...你花的時間會非常可觀
尤其是有幾萬甚至幾十萬的程式碼話....相信我 加班都加不完
不過您說的有提到一個重點
"要保持修改程式碼時註解也要跟著更新的習慣"
這不光是為了您自己下次的方便,也是為了別人的方便
我覺得這樣才是一個優秀的程式設計師
看過很多不負責任的人,沒寫註解,沒多久又跑掉....
讓之後接他Case的人....痛不欲生啊~~
還有越大型的程式...幾乎沒有一開始就能寫好
要經過不斷的測試、Debug、修改才行
小小拙見

: 雖然我建議避免寫註解，不過我會註解公式來源，表格，因為這是從程式碼中較難看出來
: 的資訊，此外如果vision control系統不提供簽入註釋或是團隊沒習慣做此動作，程式的
: 改版資訊也是我會加入註解的一個項目。

--
※ 發信站: 批踢踢實業坊(ptt.cc)
◆ From: 60.250.199.216
※ 編輯: snoopy0907      來自: 60.250.199.216       (10/08 13:33)
→ loveme00835:我覺得還是分開寫成文件比較好, 也方便版本控管
→ snoopy0907:我的公司是兩邊都做,但直接寫真的會加快很多修改效率~
推 purpose:還好有了版本控制這東西，程式碼什麼時候被誰改過還能追蹤
推 stupid0319:幾十萬程式碼一個人寫的出來嗎?
→ snoopy0907:當然不太可能一個人寫出來 所以才要更重視團隊的維護~
→ snoopy0907:不過我的老闆例外 他花了20年的時間自己研發一個系統~
→ snoopy0907:60歲 三十年前被IBN稱讚是天才...
→ snoopy0907:在我看來他C語言強的跟神沒兩樣...
推 loveme00835:0.0 那是啥公司啊
→ snoopy0907:重點是他是老闆,每天還是寫八小時以上的程式,比RD更拼
推 purpose:s大說的公司待遇好不好?好奇
→ snoopy0907:我只能說是小公司..但是是"非常賺錢"的小公司XD
→ purpose:OK，瞭解
推 chessjim:我自己在修改code與思考同一問題也需要大量註解
→ qrtt1:分開成文件常使文件 out-of-date Orz
→ horngsh:若寫dotNet的,建議多用XML註解(you know what I mean?)