專(zhuān)家分享：注釋嵌入式軟件的十大技巧

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

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

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

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

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

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