Re: [問卦] 如何寫自己容易維護 別人難懂的CODE

※ 引述《cosmite (焼き団子)》之銘言：
: 以前我寫CODE
: 都會把 段落註解 跟 方程式功能 寫得清清楚楚
: 後來 主管以為時間到CODE就會出來 對員工也越來越不尊重
: 重用嘻嘻哈哈會捧懶的員工
: 受不了了
: 自此註解都不再寫 但是元件命名 常數定義還是寫得很清楚
: 現在想要建造城牆 讓CODE不容易讀 不容易被理解
: 如何寫自己容易維護 別人難懂的CODE ?
: 多使用MACRO巨集 ? 把一個程式拆成多個小程式 ? 程式繞來繞去 ?
: 元件命名用簡寫 自己要看再查表 會不會造成自己困擾 ?
: 有卦嗎

很簡單啊

你的註解另外開一個說明檔案就好

正常來說註解都是寫在程式段落附近

你可以把註解當成說明文件就好，另外開一個檔案

然後每一個功能元件或者功能段落理論上你會開不同的程式包

每個程式包的說明也都分別獨立出來，不要寫成一個大檔

最後再開一個檔案把每個功能串起來，想看的時候就會叫出來看就好。

阿這些說明文件你交付程式的時候就收好不要放出去，只要你自己有在維護這些程式說明，最後這些說明就會只要你自己看得懂。

但實際上這就會變成你要自己維護一個字典系統跟程式文件館

通常弄到最後你會自己崩潰

為什麼會崩潰…？

因為隨著程式增修，這些東西會越來越複雜

但你改了其中一個元件很有可能全部說明都要動

但很有可能你會漏掉某些該更新的說明

幾次之後通常你就會找不到哪裡忘記更新了

我碰過的專案，即使有專門的團隊在維護字典跟說明檔案，都會出現版控問題

更不要說只有一個人…

要做不是不行

但你自己考慮好..

--

※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 114.37.158.17 (臺灣)

多人合作專案還是免不了要寫啦 不寫很難合作…

※ 編輯: ARCHERDEVIL (114.37.158.17 臺灣), 10/05/2021 20:05:00

我也很懷疑這件事情 小專案或者功能單純的專案應該可以 但成千上萬個功能元件的專案無註解一定幹到飛起來…

※ 編輯: ARCHERDEVIL (114.37.158.17 臺灣), 10/05/2021 20:13:29

然後你處理特定狀況的code用完之後點掉 之後的人就會覺得為什麼要多寫這段又點掉 時間久了之後所有人還會都忘記答案… 最後變成懸案…

※ 編輯: ARCHERDEVIL (114.37.158.17 臺灣), 10/05/2021 20:17:36

很常見啊 舉例說明 某公司裡面有一台電腦裝了某個版本的軟體 而這個軟體雖然EOS但因為業務需求不能廢 所以要存取該軟體的程式功能必須加上一小段程式才能特別處理。 半年後那個EOS的軟體終於廢止 所以相應的程式段落就被點掉。 五年後新來的回頭看某一段程式 發現有一段程式沒有註解 看起來完全沒有作用也沒有點掉… 但去問所有人，沒有人記得那一段是幹嘛的…

※ 編輯: ARCHERDEVIL (114.37.158.17 臺灣), 10/05/2021 20:55:27