在 JavaScript 源代码文档中,@param
标签提供了函数参数的各种详细信息,例如名称、类型和描述。 @param
标签带有函数参数的描述。
如果我们将@param
标签分开,它将分为三个部分。
- 首先是大括号
{}
内,可用于定义参数的数据类型。 - 第二个是参数的名称。
- 最后一部分是参数的描述,用连字符
-
符号分隔。
具体实践
/** * 这是一个示例函数 *
@param {类型} 参数名 - 参数的描述
*/ function exampleFunction(paramName) { // 函数体 }
@param {*}
中,*
是一个TypeScript的类型注解,表示任意类型