js三行注释解析

示例

/**
 * @function 数据验签
 * @param {string} sn key序列号
 * @param {string} hash 待签名数据（base64编码）
 * @param {string} signature 签名数据（base64编码）
 * @desc 验签完成后会把 signature 发送给后台
 */
function CGIVerifyOnHash(sn, hash, signature) {
    // 代码
}

注释解析

abstract

@abstract(同义词:@virtual)：此成员必须由继承程序实现(或重写)。

access

@access：指定此成员的访问级别(private、package-private、public或protected)。

alias

@alias：对待一个成员就像它有一个不同的名字。

async

@async：指示函数是异步的。

augments

@augments(同义词:@extends)：指示符号从父符号继承并添加到父符号。

author

@author：确定项目的作者。

borrows

@borrows：这个对象使用来自另一个对象的一些东西。

callback

@callback：记录一个回调函数。

class

@class(同义词:@constructor)：使用“new”关键字调用此函数。

classdesc

@classdesc：使用以下文本描述整个类。

constant

@constant(同义词:@const)：将对象记录为常量。

constructs

@constructs：这个函数成员将是前一个类的构造函数。

copyright

@copyright：记录一些版权信息。

default

@default(同义词:@defaultvalue)：记录默认值。

deprecated

@deprecated：证明这不再是首选的方法。

description

@description(同义词:@desc)：描述一个象征。

enum

@enum：记录相关属性的集合。

event

@event：记录一个事件。

example

@example：提供如何使用文档化项目的示例。

exports

@exports：标识由JavaScript模块导出的成员。

external

@external(同义词:@host)：标识外部类、命名空间或模块。

file

@file(同义词:@fileoverview， @overview)：描述一个文件。

fires

@fires(同义词:@emits)：描述此方法可能引发的事件。

function

@function(同义词:@func， @method)：描述一个函数或方法。

generator

@generator：指出一个函数是一个生成器函数。

global

@global：记录一个全局对象。

hideconstructor

@hideconstructor：指示不应显示构造函数。

ignore

@ignore：从文档中省略符号。

implements

@implements：这个符号实现了一个接口。

inheritdoc

@inheritdoc：指示符号应该继承其父文档。

in

@in：记录一个内部对象。

instance

@instance：记录一个实例成员。

interface

@interface：这个符号是一个其他人可以实现的接口。

kind

@kind：这是什么符号?

lends

@lends：对象文字上的文档属性，就好像它们属于具有给定名称的符号一样。

license

@license：标识应用于此代码的许可。

listens

@listens：列出符号侦听的事件。

member

@member(同义词:@var)：文档的一个成员。

memberof

@memberof：这个符号属于父符号。

mixes

@mixes：这个对象混合了来自另一个对象的所有成员。

mixin

@mixin：记录一个mixin对象。

module

@module：编写JavaScript模块的文档。

name

@name：记录对象的名称。

namespace

@namespace：记录名称空间对象。

override

@override：表示符号覆盖其父级。

package

@package：这个符号应该是包私有的。

param

@param(同义词:@arg， @argument)：将参数记录到函数中。

private

@private：这个符号是私有的。

property

@ property(同义词:@prop)：记录对象的属性。

protected

@protected：这个符号是被保护的。

public

@public：这个符号是公开的。

readonly

@readonly：这个符号是只读的。

requires

@requires：这个文件需要一个JavaScript模块。

returns

@returns(同义词:@return)：记录函数的返回值。

see

@see：有关更多信息，请参考其他文档。

since

@since：这个功能是什么时候添加的?

static

@static：记录一个静态成员。

summary

@summary：完整描述的简短版本。

this

@this：这里的“this”关键字指的是什么?

throws

@throws(同义词:@exception)：描述可以抛出哪些错误。

todo

@todo：记录要完成的任务。

tutorial

@tutorial：插入一个链接到包含的教程文件。

type

@type：记录对象的类型。

typedef

@typedef：记录自定义类型。

variation

@variation：用相同的名称区分不同的对象。

version

@version：记录项的版本号。

yields

@yields(同义词:@yield)：记录生成器函数产生的值。

todo

@todo：记录要完成的任务。

tutorial

@tutorial：插入一个链接到包含的教程文件。

type

@type：记录对象的类型。

typedef

@typedef：记录自定义类型。

variation

@variation：用相同的名称区分不同的对象。

version

@version：记录项的版本号。

yields

@yields(同义词:@yield)：记录生成器函数产生的值。