學習目的:
1,爲什麼要註釋
2,怎麼做註釋
爲什麼要註釋
剛開始入行的時候,覺得代碼自己看得懂就可以。寫註釋幹嘛?浪費時間。後面又一次我的代碼被大佬review,一頓惡罵後,我還是沒有覺得這個重要性。直到有一天我背安排對一個功能進行二次開發的時候,我記得我從早上打開電腦能夠嘴巴開始碎碎唸到下班的時候,才明白:註釋真的很重要。
1,方便自己排查問題
2,方便後面的同事填坑
3,爲了人身安全
4,爲了漲薪
怎麼做註釋
開頭:
/**************************************************************************************************
* Name: CPQ_DiscountVocherCtl
* Object:
* Purpose: Controller for Aura CPQ_DiscountVoucher
* Author: Christ Lai([email protected])
* Create Date: 2019-08-07
* Modify History:
* 2019-08-07 xiong lai Create this class
**************************************************************************************************/
中間:
1,內部類的變量要給字段後面寫上中文備註,這個字段啥意思(大部分命名很難做到見名知意)
2,方法上面寫上【方法的功能】【方法的入參意義】【修改內容、時間、作者、郵箱】
3,在重要的List,Set,Map定義的變量上寫上啥意思(最好在開發入場前,先熟悉開發的代碼規範)
4,如果涉及到特別複雜的判斷,邏輯等。儘量長的要scroll才能看到的一句代碼拆成多個原子代碼,這樣後面的人會感謝你的。比如if(A||((B&&C)|| D&&G)....)反正我也不知道我自己寫的到底缺了括號沒。這種語句,最好多定義幾個變量每個邏輯放一個變量,加上註釋。
後面:
1,這部分看大家的意願
1)我建議在apex的類後面寫上自己類涉及的測試數據,每個剛寫完的人最熟悉數據構造。可能隔一天在回頭寫,作者自己還要琢磨琢磨怎麼創建數據。這個能節省很大的人力成本,親測!!!
2)結尾的地方如果有未完成的事情,新加一個TODO FIXED表格
/**************************************************************************************************
Requirement Date Author Status
xxxxx xxx xxxx TODO
xxxxx xxx xxxx FIXED
**************************************************************************************************/
如果有錯,請指出。一起進步!