良好的注释使代码更具有可读性和可维护性,尤其是多人协作的项目,不要让团队其他成员来猜测一段
    代码的意图。

    注释风格应当相对简洁,做如下规范:

    • 区块注释放在单独一行。
    • 保持注释内代码的缩进。

    提示:通过扩展 等工具(例如emmet-plus)可以快速输出统一的注释风格。

    注释横线的长度为80个字符,作为换行参考。

    一级区块注释

    1. 一级区块注释
    2. ========================================================================== */

    二级区块注释

    风格的注释以 /* 开始,每行以 号开头。

    1. /**
    2. * Doxygen 风格的注释示例
    3. * @author: 一丝
    4. * @note: 注解
    5. * @doc: 相关文档
    6. * 这里是更详细的描述,当然我们要把字数控制在每行80个字符(40个汉字)以内。如果
    7. * 一行写不下,需要另起一行。
    8. */

    Doxygen 风格的注释内如果包含其他代码,不写开头的 * 号,以方便复制代码。

    Sass, LESS, Stylus 中可以使用单行注释。

    1. // 注释内容