我是程式註解的信徒,程式要容易被理解的關鍵如下: 註解要像劇本一樣,主程式寫大綱,之後每隔一段程式註解該段的功能,最高段是只看註解,不看程式碼就可以初步理解程...
註解的目的是幫助接手維護的工程師,包含自己 (?) 快速了解程式目的。注意這裡講的是工程師,不是對程式語法有疑問,甚至連 Domain 單字都還沒建立的人。 結...
PG常覺得寫的func包含細部邏輯都很容易理解,所以不寫註解,但不要太高估別人理解能力 你覺得很好懂,但code自己寫的當然好懂,我也覺得我寫得很超直白容易理解...
我只會在程式開始寫註解,大概寫這隻程式的功能、日期、編修原因、要求編修的人,影響的範圍。另外在函數的起頭寫註解,及特殊段落與語法會特別註記。 註解除了要讓自己快...