js函数注释规范
| 符號 | 用法 |
|---|---|
| @param | @param {類型} 參數名 描述 |
| @return | @return {類型} 描述 |
| @author | @author 作者 |
| @version | @version 版本號 |
/**
* 測試
* @param {number} num
* @return {void}
*/
function test(num) {
console.log(num);
}
其他
@api: 提供給第三方使用的接口
@author: 標明作者
@param: 參數
@return: 返回值
@todo: 待辦
@version: 版本號
@inheritdoc: 文檔繼承
@property: 類屬性
@property-read: 只讀屬性
@property-write: 只寫屬性
@const: 常量
@deprecated: 過期方法
@example: 示例
@final: 標識類是終態, 禁止派生
@global: 指明引用的全局變量
@static: 標識類、方法、屬性是靜態的
@ignore: 忽略
@internal: 限內部使用
@license: 協議
@link: 鏈接,引用文檔等
@see: 與 link 類似, 可以訪問內部方法或類
@method: 方法
@package: 命名空間
@since: 從指定版本開始的變動
@throws: 拋出異常
@uses: 使用
@var: 變量
@copyright: 版權聲明
總結
- 上一篇: 查看hive中某个表中的数据、表结构及所
- 下一篇: 2020年六月份qq邮箱代收搜狐邮箱