在JSDoc中定义类参数的类型可以使用@param
标签来实现。下面是一个示例:
/**
* @class
* @classdesc 表示一个人的类
*/
class Person {
/**
* 创建一个人的实例
* @param {string} name - 人的姓名
* @param {number} age - 人的年龄
*/
constructor(name, age) {
this.name = name;
this.age = age;
}
/**
* 打印人的信息
*/
printInfo() {
console.log(`姓名:${this.name},年龄:${this.age}`);
}
}
// 创建一个人的实例
const person = new Person('张三', 20);
person.printInfo();
在上述示例中,使用@class
标签定义了一个类Person
,使用@classdesc
标签提供了对类的描述。在构造函数constructor
中,使用@param
标签定义了两个参数的类型和说明。参数name
的类型为string
,参数age
的类型为number
。这样可以提供给开发者在使用该类时了解参数的类型和作用。
注意:在JSDoc中,可以使用多种方式来定义参数的类型,例如使用{}
、[]
、<>
等符号。具体使用哪种方式可以根据个人习惯来选择。
领取专属 10元无门槛券
手把手带您无忧上云