維護修改註解

Posted by Bruce Tsai

原則

• 在維護修改原程式邏輯時，需在修改的同時，增加對應修改的原因、時間、作者等相關資訊。便於在後續回溯相關問題時，能快速了解原因。

做法：儘可能標註修改時的資訊

• 標註修改開始區段
• 標註修改結束區段
• 修改原因
• 變更的邏輯內容
• 修改的作者
• 修改日期

/**
 * Begin of SR121
 * 說明 : 新增SR121相關規則。
 * 作者 : Yang
 * 日期 : 2015/11/25
 */
if ("201".equals(input.getOffer())) {
    input.addChild("amount", 1);
} else {
    // more code here
}
// End of SR121