13個代碼注釋的小技巧 ? 這篇文章是由José M. Aguilar在他卓越的博客中以西班牙語的形式首發，其后Timm Martin在獲得Aguilar先生的授權下，對該文章進行翻譯、修改，并且在DevTopics上發布。 以下13個小技巧可以使得你的代碼在長時間內依然能夠保持容易理解和維護。 1. 對不同級別的代碼進行注釋 對于不同級別的代碼塊，要使用統一的方法來進行注釋。例如： 對于每一個類，需要包含一段簡明扼要的描述，作者和上一次修改的時間 對于每一個方法，需要包含這個方法的用途，功能，參數以及返回結果 當你在一個團隊里面的時候，采用一套注釋的標準是非常重要的。當然，使用一種大家都認可的注釋約定和工具（例如C#的XML注釋和Java的Javadoc）在一定程度上能推動這項任務。 2. 使用段落注釋 首先把代碼塊分解成多個“段落”，每一個段落都執行單一的任務；然后在每一個“段落”開始之前添加注釋，告訴閱讀代碼的人接下來的這段代碼是干什么用的 復制內容到剪貼板 代碼: // 檢查所有記錄都是正確的 foreach (Record record in records) { ??? if (rec.checkStatus()==Status.OK) ??? { ??????? . . . ??? } } // 現在開始進行處理 Context ctx = new ApplicationContext(); ctx.BeginTransaction(); . . . 3. 對齊注釋行 對于那些在行末寫有注釋的代碼，應該對齊注釋行來使得方便閱讀 const MAX_ITEMS = [...]

可以推薦看那看這些文章：

struts2代碼執行漏洞

wordpress用代碼插入flash

dapeng 2012主題

《別讓我思考》web設計之道

來自無覓網絡的相關文章：

一鍵清理系統垃圾（附帶代碼） (@laycher)

記事本的兩個小技巧 (@laycher)

RAMDisk,QSoft RamDisk安裝和設置視頻教程 (@laycher)

外文文獻搜索技巧 (@laycher)

無覓

轉載于:https://www.cnblogs.com/joypen/archive/2011/12/31/2322000.html

總結

以上是生活随笔為你收集整理的13个代码注释的小技巧的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。