編寫自文檔化的代碼

文所以載道也。  —— 宋·周敦頤《通書·文辭》 對於我們程序員來說，我們的工作也是寫作——幾乎每天都要寫代碼；而且還要載「道」，不僅僅要滿足客戶的需求，還要讓代碼具有高度的可讀性，這樣其他的程序員可以更容易地對代碼進行修改和擴展。 按這樣的要求，我們需要爲代碼編寫足夠的文檔，也就是將代碼「文檔化」。常見的做法有兩種，外部文檔和註釋。 外部文檔 外部文檔指的是在代碼文件之外編寫的附加文檔，比如在W

>>阅读原文<<