对象注释
/**
* @namespace
* @property {string} arr.aa 说明
*/
函数注释
// utils.js
/**
* @file 这是工具库文件,提供通用的方法
* @version 0.0.1
* @todo 英文字母和数字的对应关系的方法
* @author chxu
/*
/**
* @param {obj} item 一个对象
* @return {string} key 返回值是字符串
* @see setValue
* @desc 根据key获取对应的值
*/
function getValue (item, key) {
return item[key]
}
/**
* @param {string} [value] [xx]表示xx是可选参数
*/
function setValue (key, value, item) {
// do something
}
JSDoc 基本注释规范
最新推荐文章于 2024-04-26 09:16:42 发布