jsdoc Javascript文档教程与实例

在这篇文章中，我们将通过实例来学习JSdoc函数标签。

函数文档

任何函数都可以用函数名返回类型和接受的输入类型来声明。@param标签为一个javascript函数提供参数。这包括在大括号和小括号中的参数类型以及参数的描述。

接受的参数类型是字符串、对象或指向代码的命名空间。

@param标签

下面的例子说明了如何使用@param标签来记录javascript函数的名称、类型和描述 下面是一个函数名称记录的例子

/**
 * @param This is Simple function in javascript
 */
function method1() {
    console.log('Hi Simple Function');
}

下面是一个函数名称和类型文档的例子

/**
 * @param {string } This is Simple function in javascript
 */
function method1(msg) {
    console.log('Hi Simple Function'+msg);
}

下面是一个函数名称、类型和描述的例子

/**
 * @param {string } method1- simple function in javascript
 */
function method1(msg) {
    console.log('Hi Simple Function'+msg);
}

可选参数和默认值

函数可以应用可选的参数和默认值。函数的文档也可以包括可选的和默认值。

/**
 * @param {string} [name= Kiran] - Function with optional Default parameters.
 */
function functionOptionalDefault(name) {
    if (!name) {
        name = 'Kiran';
    }
    console.log('Hi ' + name);
}

函数参数联盟示例 联盟类型是复杂的类型，在其上可以使用符号|应用多种类型。

/**
 * @param {(string|string[])} [name=Kiran] - String or multiple strings
 */
function mymethod(name) {}

回调函数示例

在javascript中，函数参数可以接受回调函数。@callback标签被用来指定回调类型。

/**
 * mycallback is callback function defined
 *
 * @callback mycallback
 * @param {string} parameters string
 */

/**
 * Callback handles certain operations
 * @param {mycallback} mycallback - Function with callback example
 */
function functioncallbackexample(mycallback) {
    // code
};