代码注释怎么写

00:00

  哈喽！大家好，欢迎来到牛牛博客，今天简单给大家讲下代码注释怎么写。

  代码注释的目的与作用

  方便编辑、提高可读性和可维护性。

  代码注释语法和快捷键

单行注释：// 
快捷键：ctrl+/ 
多行注释：/**/ 
快捷键：ctrl+shift+/

  代码注释的规范

  1、注释符与注释内容之间加一个空格

  2、注释行与上方代码间加一个空行

 HTML代码顶部注释

 /**
  * @description: 程序说明
  * @author: name
  * @update: name(xxxx-xx-xx)
  */

HTML代码注释

<!--需要注释的部分-->

CSS代码注释

/**
 * @func
 * @todo 这个函数需要优化
 * @desc 一个带参数的函数
 * @param {string} a - 参数a
 * @param {number} b=1 - 参数b默认值为1
 * @param {string} c=1 - 参数c有两种支持的取值</br>1—表示x</br>2—表示xx
 * @param {object} d - 参数d为一个对象
 * @param {string} d.e - 参数d的e属性
 * @param {string} d.f - 参数d的f属性
 * @param {object[]} g - 参数g为一个对象数组
 * @param {string} g.h - 参数g数组中一项的h属性
 * @param {string} g.i - 参数g数组中一项的i属性
 * @param {string} [j] - 参数j是一个可选参数 
 * @returns {boolean} 返回值为true
 */