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

看板Programming作者 (!H45)時間15年前 (2009/09/07 07:07), 編輯推噓3(308)
留言11則, 4人參與, 最新討論串22/34 (看更多)
※ 引述《realmeat (真肉)》之銘言: : ※ 引述《amppp (Monte-Carlo)》之銘言: : : 我的感想: : : 程式是邏輯思考的實現,是可以被數學化的,所以寫程式應該要像寫證明一般 : : 簡潔清楚,雖然我也想一行程式只做一件事情,但是平行計算程式往往不能這樣 : : ,這是序列式程式(serial code)才比較容易達成的。 : : 我的目標一直都是以最短程式碼,可改變性程式碼為目標。 : : 不斷地練習,清楚的邏輯思考,進而建立自己寫程式的習慣,好的習慣不會讓自己 : : 陷於無窮debug迴圈。程式寫久了,新的程式只是剪下貼上間就完成了。 : 我的目標則是 : 程式碼當中不使用到一行註解, 就能讓別人了解你寫的程式 程式碼只能描述程式要做的事情,無法描述程式為什麼要做這些事。 描述程式碼運作的原理與原因必須寫在註解或外部文件 如果沒有寫這些額外的說明 就算其他人看懂程式每一個步驟,也沒有辦法完全理解其意義 舉例而言: window = create_window( image ); pixels = collect_pixels_from( window ); difference = calculate_difference_from( pixels ); similarity = infer_similarity_from( difference ); filtered_pixel = convolution( pixels, similarity ); 上面五行簡單的程式段落,看英文就知道 第一步是從 image 建立 window 第二步是從 window 收集 pixels 第三步是從 pixels 計算 difference 第四步是從 difference 推論 similarity 第五步是將 pixels 和 similarity 做 convolution 運算 程式碼非常清楚地把程式做的事情寫明白了,但是外行人沒做過影像增強根本不懂為什 麼要做這些事情。 首先,為什麼要建立 window? window 是什麼? 做什麼用的? 看實作細節可能會懂 但是還不如直接在上面寫些註解 // window 是 image 的某一小塊區域,用來圈選增強單一像素所需要考慮的範圍 再來,為什麼要收集 pixels? // 收集 pixels 了解像素之間的關係,動態且適應性地決定每個像素對增強結果的 // 重要性。 然後,為什麼要計算 difference? 為什麼要推論 similarity? 為什麼要做 convolution? 整個流程到底試圖完成什麼事情? 其目的是什麼? 這些事情並不是以變數命名或是函數命名就可以輕鬆交代的 仍然有很多事情,像是設計樣式、多緒陷阱、演算法註記、TODO、FIXME、……等 還是得靠註解和文件幫忙補完 如果有那種完全沒有註解與說明文件的程式碼維護兩年以上的 請務必告知我。 : 要做新的東西, 需要運用原本所寫的功能 : 只要把檔案搬過去就能work, 做到模組化 : 程式寫到現在 感覺只是對不同的資料進行處理 : 看最底層只是 許許多多的指令, 按照自己設計的動作排序好 : 沒有啥需要被證明的 : 對我來說真正的課題 則是在程式碼的可讀性以及可移植上才是重點 可讀性和可移植性我也認為很重要 問題是,在完成了足夠的可讀性和移植性之後 是不是再補上一些註解和文件會更好呢 :D -- ※ 發信站: 批踢踢實業坊(ptt.cc) ◆ From: 114.33.235.24

09/07 08:34, , 1F
這篇中肯!
09/07 08:34, 1F

09/07 12:06, , 2F
立意是不錯,但這個例子不好,
09/07 12:06, 2F

09/07 12:06, , 3F
此例註解應該指引該參考的文獻即可
09/07 12:06, 3F

09/07 12:07, , 4F
背景知識只要引用來源即可,
09/07 12:07, 4F

09/07 12:08, , 5F
作者自創的東西才需要寫進駐解裡
09/07 12:08, 5F

09/07 18:26, , 6F
以上一篇的思維,應該會希望你把程式抽出
09/07 18:26, 6F

09/07 18:26, , 7F
然後放在一個叫function_do_xxxx()的函式
09/07 18:26, 7F

09/07 18:27, , 8F
不過我覺得這種方法,跟註解是同樣的事
09/07 18:27, 8F

09/08 02:53, , 9F
指的是我的思維嗎?不全然,太刻意
09/08 02:53, 9F

09/08 02:57, , 10F
以這個例子,註解寫 影像增強 的專用英文
09/08 02:57, 10F

09/08 02:58, , 11F
最多附上網址就算很詳盡了
09/08 02:58, 11F
文章代碼(AID): #1Af42uUe (Programming)
討論串 (同標題文章)
文章代碼(AID): #1Af42uUe (Programming)