前端文件注释和方法注释总结

棠樾

已于 2022-03-25 11:16:19 修改

阅读量1.3k

点赞数 3

分类专栏： javaScript 文章标签： javascript

于 2022-03-25 11:00:29 首次发布

本文链接：https://blog.csdn.net/weixin_44447255/article/details/123730221

版权

本文总结了前端文件和方法的注释规范，包括文件注释的@description、@author、@date、@lastModifiedBy和@lastModifiedTime字段，以及方法注释的@description、@param、@returns和@example，帮助提升代码可读性和维护性。

摘要由CSDN通过智能技术生成

文件注释：

文件头部增加文件注释，用于描述文件的基本信息。便于阅读代码时，快速的理解该文件的功能。主要包含以下字段：

@lastModifiedTime 最新的更新时间

/**
 * @description 文件干啥用的
 * @author Morning
 * @date 2022-03-25 16:16:52
 * @lastModifiedBy Morning
 * @lastModifiedTime  2022-03-25 16:16:52
 */

方法注释:

@description 一个参数用来描述方法说明。
@param 描述创建实例时的“参数”。有三个参数，第一个参数表示“参数”的数据类型，用 {} 包含。第二个参数表示“参数”名。第三个参数表示“参数”的说明。 “参数”和“参数”说明用‘ - ’连字符来连接，连接符前后需要空格。如果“参数”是个对象则用多个@param 来声明。 “参数”名用[]括起来是,该参数是可选参数，[]内可以用=设置默认参数。“参数”是个数组时，数据类型后添加[]。
@returns 标识方法的返回值包含两个参数。第一个参数是返回的数据类型，可返回多种数据类型，用|分割。第二个参数是返回值的说明。
@example 通过例子来解释方法怎么用。