前端代码注释

代码为什么需要注释

“代码千万行，注释第一行；编程不规范，同事两行泪；”代码注释为啥很重要呢？以下是我的一些想法:

• 提高代码可读性

《黑客与画家》里面有句话“程序写出来是给人看的，附带能在机器上运行”。既然是给人看的，我觉得有两个方面就比较重要。一、代码写的好，好的代码依赖于coder的代码功底。要写出好的代码，需要多修炼内功。二、注释写的好。就像我们上学的时候看文言文，字基本都认识，但是连在一起就是不知道什么意思。这个时候就依赖于注释了，注释能把文言文中难懂的词汇翻译成白话。代码注释也是一样的道理，用来解释代码的意义。

• 快速的导出接口文档

如果需要和外部对接时，优秀的代码注释可以通过 jsdoc快速导出接口文档

• 提高代码编写效率和代码准确性

9102了大部分IDE都能根据注释去分析，提供一写智能提示，提高代码编写效率，降低我们代码的出错率。

代码注释的原则

一个原则是“as short as possible，as long as necessary ”。代码注释是必须的，但是要避免注释过多过滥，不要为了注释而注释。我们应该提高修炼好内容，提高代码本身的可读性。以下是一些需要添加注释的地方：

• 文件描述注释
• 类描述注释
• 组件暴露出来的公共方法࿰