注释那些事儿

好的注释可以提高代码的可读性和可维护性，从而提高代码质量。

 

那么什么是好的注释？如何写出好的注释？本文将从注释的目的和原则出发对 JS 注释进行探讨。

注释的目的：

• 提高代码的可读性，从而提高代码的可维护性

 

注释的原则：

• 如无必要，勿增注释 ( As short as possible )

• 如有必要，尽量详尽 ( As long as necessary )

 

我们写注释，是为了给代码的读者（包括我们自己，也可能包括机器，如 jsdoc）看，帮助读者阅读理解代码并进行维护。