※ 引述《H45 (!H45)》之銘言： : ※ 引述《realmeat (真肉)》之銘言： : : 我的目標則是 : : 程式碼當中不使用到一行註解, 就能讓別人了解你寫的程式 : 程式碼只能描述程式要做的事情，無法描述程式為什麼要做這些事。 : 描述程式碼運作的原理與原因必須寫在註解或外部文件 : 如果沒有寫這些額外的說明 : 就算其他人看懂程式每一個步驟，也沒有辦法完全理解其意義 : 舉例而言： 舉一個發生在我身上的例子好了 我有一個寫了快兩年的程式 因為那是我自己開發的 而為了開發這個程式必須先看相關的標準(DICOM) 為了怕別人不想花時間看第三章的相關部份 印象中我程式裡面比較重要的地方都會寫上註解 不然每個 ECG 儀器廠商的資料都不一樣 別人不一定知道那些 sample 排列及還原的方式 (應該吧，手邊沒有留那些 source code？) 離開那家公司也快一年半了 前兩個禮拜 部門的小主管打電話來問我問題 因為我在圖書館看書沒接到 隔天回電時 他才說本來是想問我相關問題 後來已經在註解裡找到答案了 坦白說 當時的心情真的是很爽 真是不枉費我寫程式以來保持的好習慣呀 ... XD 尤其自己年紀大了 自己的程式更是想到就寫註解 即使從該 function 的註解就可以知道用途 我還是會在呼叫的地方再寫一次 我可不想以後想修改自己的程式 還要回頭想老半天 時間是很寶貴滴 ~ --

※ 發信站: 批踢踢實業坊(ptt.cc) ◆ From: 114.45.220.4