失傳的絕學：代碼註釋的藝術

聲明：本篇文章系標題黨，僅供娛樂消遣；
注意：文中記錄的江湖伎倆請在使用後銷燬，避免對部分編譯器和團隊成員形成傷害。

代碼註釋一般是用來對抽象代碼內容作補充說明，下面介紹的兩種註釋方法用於代碼編寫的調試過程，發佈的時候應該避免出現這種的註釋。

1. if else 註釋法

只運行 eatKfc()：

//*                     
eatKfc();
/*/                     
eatMcdonalds();        
//*/

只運行 eatMcdonalds()：

/*
eatKfc();
/*/
eatMcdonalds();
//*/

兩者都運行：

//*
eatKfc();
//*/
eatMcdonalds();
//*/

2. 整段註釋法

不註釋：

/**/
var foo = function() {
    ...
};
/**/

整段註釋一：

/** /
var foo = function() {
    ...
};
/**/

整段註釋二：

/**
var foo = function() {
    ...
};
/**/

---

不少先進的編輯器已經支持[選擇代碼+快捷鍵]一步完成註釋了，但在刀耕火種的年代，程序員祖先用本身的智慧填補了生產工具上的落後。

平時看到有用的內容摘錄到筆記中的是一個好習慣，以上內容來自個人摘錄筆記。

延伸話題：

• 你們都有哪些好用的代碼註釋方法