技巧7——圖表的作用

　　在一個項目的軟件實現(xiàn)階段開始之前，應(yīng)該有一個軟件設(shè)計階段。這個設(shè)計階段無疑會生成許多漂亮的圖（如流程圖和狀態(tài)機），并被用于實際實現(xiàn)。雖然這些文檔作為軟件的開發(fā)路線圖，但在開發(fā)和測試過程中總會出現(xiàn)偏差！遺憾的是，這些變化很少會返回到圖表中。結(jié)果是設(shè)計文檔和軟件的不匹配！在實現(xiàn)和測試階段將這些圖表放在手邊，以便發(fā)生上述偏差時這些圖表能及時得到更新。將這些圖表留到日后更新永遠不是正確的做法。雖然我們總是有返回去更新或修復(fù)的良好愿望，但這永遠不是合適的時機。

　　技巧8——保持注釋框使用的一致性

　　就像聽起來一樣奇怪，許多網(wǎng)絡(luò)爭論的內(nèi)容是何時、哪里使用何種類型的注釋框！不過嚴肅地講，不管你的信仰是什么，歸根到底是一致性問題。如果一個團隊決定只使用/*…*/類型的注釋，那么就只使用這種類型。如果決定使用//類型，那就只使用//類型。作者個人的觀點是傾向于使用/*…*/進行函數(shù)和模塊級說明，使用//進行函數(shù)代碼說明。不管選擇是什么，確保每次都按同樣的方式去做，這樣有助于生活更加輕松。

　　技巧9——使注釋更容易閱讀（即格式的美化）

　　為了確保避免誤解并由此產(chǎn)生代碼缺陷，使代碼保持結(jié)構(gòu)化和容易閱讀很重要。注釋也一樣。偶爾結(jié)構(gòu)化的注釋會使眼睛很難捕捉注釋，更難捕捉不在合適位置的內(nèi)容。應(yīng)該對注釋進行格式化處理，這樣如果代碼打印出來時（雖然現(xiàn)在不常打印，但我偶然仍會打印代碼）注釋就不會分到好幾頁上去。在大塊注釋（如文件頭或函數(shù)注釋）中，如果你使用塊指示器，千萬不要包含進任何拖尾字符（如#或*），要不只會使文檔更新變得更加困難。

　　技巧10——嵌入圖像和圖表

　　借助自動化工具的使用，在注釋文檔中包含編碼標準、縮寫詞、項目細節(jié)、要求和大量其它條款就成了可能。甚至能夠包含諸如流程圖等設(shè)計性圖表！使用這類功能允許代碼庫不僅包含執(zhí)行代碼和邏輯，還包含你想要了解的項目所有內(nèi)容，并且所有信息都放在同一個地方。