💎一站式轻松地调用各大LLM模型接口,支持GPT4、智谱、星火、月之暗面及文生图 广告
添加注释的目的是为了提高工作效率,便于后续开发人员开发维护以及在网站建设中,使结构更加清晰,代码简明有序,提高可读性和可维护性。养成良好的注释习惯,是作为一名开发人员必备的条件。 <br /><br /> >注释符与注释内容之间加一个空格,注释行与上方代码间加一行空行,注释内容清晰详细! ``` 单行注释:// 我是无敌可爱宁! 多行注释:/* 我是无敌可爱宁!*/ ``` <br /> >顶部文档信息:包括文件描述、原始作者,如果有更新,则需要添加更新内容、更新作者和更新时间 ``` /**   * @description 文档说明  * @author:作者  * @date:编译时间 */ ``` <br /> >描述对象的属性 ``` /**   * @var {object}   * @property {string} a - 属性a  * @property {string} b - 属性b   */ let foo = {  a: 'a',    b: 'b' } ``` <br /> >JS方法模块多行注释 ``` /**   * 函数描述 * 与此函数相关联引入的其他函数,并说明该函数具体位置以及说明其功能 * @param:{string} 参数1的说明 * @param:{string} 参数2的说明 * @return: {Object} 返回值描述 */ ```