前端代码注释格式

项目开发

发布日期: 2021-04-23

更新日期: 2024-06-05

文章字数: 256

阅读时长: 1 分

1. HTML注释

单行注释

<!-- Comment Text -->

模块注释

 表示模块开始， 表示模块结束。

<!-- S Comment Text A -->   
<div class="mod_a">
    ...
</div>
<!-- E Comment Text A -->

2. CSS注释

单行注释

/* Comment Text */
.title {
    color: red;
}

模块注释

/* Module A
---------------------------------------------------------------- */
.mod_a {}

/* Module B
---------------------------------------------------------------- */
.mod_b {}

文件信息注释

/**
 * @desc File Info
 * @author Author Name
 * @date 2015-10-10
 */

3. JS注释

单行注释

// Comment Text
let a  = 1;

多行注释

/**
 * 代码执行到这里后会调用setTitle()函数
 * setTitle()：设置title的值
 */

函数注释

/**
 * 两数求和
 * @param {number} x - 参数1
 * @param {number} y - 参数2
 * @return {number} 
 * @author snail-lu 2022/05/01
 * @version 1.0.0
 */
function sum (x, y) {
    return x + y;
}

方法注释

/**
 * 通用类
 * @class Common
 */
class Common() {
    /**
     * @method sum
     * @for Common
     * @param {number} x - 参数1
     * @param {number} y - 参数2
     * @return {number} 和
     */
    sum(x, y) {
        return x + y;
    }
}