- 注釋的的恰當(dāng)用法是彌補(bǔ)我們?cè)谟么a表達(dá)意圖時(shí)遭遇的失敗。
- 程序員應(yīng)該花更多的心思把代碼的真實(shí)意圖表達(dá)清楚，準(zhǔn)確。
- 注釋不能美化糟糕的代碼。
- 有時(shí)候代碼本身不足以解釋其行為。
if(person.isNew & HOURLY_FLAG)&& person.age>65)
or
if(person.isEligibleForFullBenefits())
- 真正的好的注釋是你想辦法不去寫(xiě)的注釋。
- 注釋可以放大某種看來(lái)不合理之物的重要性。
- 想想如果沒(méi)有JAVA doc我們?cè)撊绾问褂肑AVA API？
- 簡(jiǎn)單的函數(shù)是多余的。
- 拒絕寫(xiě)廢話注釋。
/**
* Return the day of the month.
*/
public int getDayOfMonth(){
return dayOfMonth;
}
- 直接把代碼注釋掉是討厭的做法。直接刪掉，我們有先進(jìn)的源代碼系統(tǒng)如此之久，這可以直接刪掉。
writeNote();
// writePaper();
writeEnd();
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。
