失传的绝学：代码注释的艺术

声明：本篇文章系标题党，仅供娱乐消遣；
注意：文中记录的江湖伎俩请在使用后销毁，避免对部分编译器和团队成员造成伤害。

代码注释通常是用来对抽象代码内容做补充说明，下面介绍的两种注释方法用于代码编写的调试过程，发布的时候应该避免出现这种的注释。

1. if else 注释法

只运行 eatKfc()：

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

只运行 eatMcdonalds()：

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

二者都运行：

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

2. 整段注释法

不注释：

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

整段注释一：

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

整段注释二：

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

---

很多先进的编辑器已经支持[选择代码+快捷键]一步完成注释了，但在刀耕火种的年代，程序员祖先用自己的智慧填补了生产工具上的落后。

平时看到有用的内容摘录到笔记中的是一个好习惯，以上内容来自我的摘录笔记。

延伸话题：

• 大家都有哪些好用的代码注释方法