代碼註釋的作用,簡單的說,就是讓人能夠讀懂你的代碼。
讀 懂代碼有什麽用?當你接手他人的工作時,註釋可以幫助你瞭解代碼隱含的業務邏輯。我在接手ATIP這個系統時,看到前人寫的幾十、上百行代碼中只有一兩行 註釋,真恨不得提刀躍馬去砍了那人。當你修改自己的代碼時,註釋可以讓你知道這段代碼的作用、初衷,并可以幫你分析修改這段代碼可能造成的影響。而且很多 時候,當我回頭看自己三個月前寫的代碼時,常常發現自己甚至忘記了我居然寫過這段代碼!這種狀態下,讓我去解釋、修改,簡直是天方夜譚了。
當然,好的命名可以對代碼進行自解釋。這與寫註釋不衝突,而是互補。
用具體的例子來解釋,可以比較以下幾組代碼。黃色底色為無註釋版,綠色底色為有註釋版。
對比組三。方法cunstomerSheet的兩個參數i和j是做什麽用的?這種參數命名是應該挨駡的。另外,這個方法的適用範圍也在註釋中寫了出來。
public class DefaultExcelWriterServiceImpl implements ExcelWriteService {
protected void customerSheet(int i, int j, WritableSheet sheet)
    throws RowsExceededException, WriteException {
}}

/**
* 默认的一个excel数据写入器。用於處理簡單excel的數據導入。所謂簡單,是指表頭只有一行、整個excel都沒有合並單元格的情況
*
* @author 团长
* @since 2012-9-26
*/

public class DefaultExcelWriterServiceImpl implements ExcelWriteService {
/**
* 對當前sheet進行特殊處理的方法。由子類實現。<br />
* 2012年11月12日 項目程序執行統計表中有一個該方法的實現。
*
* @author 團長
* @since 2012-11-12
* @param i
*                        :行號
* @param j
*                        :列號
* @param sheet
*                        :待處理的sheet
* @throws RowsExceededException
* @throws WriteException
*/

protected void customerSheet(int i, int j, WritableSheet sheet)
    throws RowsExceededException, WriteException {
}}