JavaScript 注释规范 - xw332/xw332.github.io GitHub Wiki

总原则

1. As short as possible（如无必要，勿增注释）。尽量提高代码本身的清晰性、可读性。
2. As long as necessary（如有必要，尽量详尽）。合理的注释、空行排版等，可以让代码更易阅读、更具美感。

总之，注释的目的是：提高代码的可读性，从而提高代码的可维护性。

扩展链接

编码与文档风格讨论