Good code is its own best documentation. As you're about to add a comment, ask yourself, "How can I improve the code so that this comment isn't needed? Improve the code and then document it to make it even clearer. - Steve McConnell.
2009年1月30日 星期五
Q20: 好的程式本身就是最好的註解。加程式註解前想想：如何改善程式碼讓我不需要加這個註解？改善程式碼並加上註解讓你的程式更清楚 - Steve McConnell.
訂閱：
張貼留言 (Atom)
我倒不怎麼同意Steve McConnel的說法，如果你發展軟體工作主要是在撰寫程式而且程式不大不小，則McConnel的說法可能適用，如果程式大至幾mega，或使用MDA技術，這則諺語恐怕不太管用。例如Agile MDA就認為model是相當程式，目前MDA的「信仰者」在苦戰，如何使Modeling語言能百分百顯示需求，而不在程式的撰寫，對MDA而言，寫程式已非要事。像XP是寫一點測試一點，然後再以iterative & incremental方法完成系統，如此McConnel之言可能是對的。
回覆刪除任何諺語都有其為「真」的先決與充分條件，當然我們無法要求諺語的提供者說明這些條件，不過沒有一則諺語是放之四海皆準的，因此讀者使用時最好能考慮該諺語可用的環境或範疇，才不至於被誤導。