在单个类中为2个构造函数使用相同的JavaDoc

时间:2019-05-03 14:34:24

标签: java class constructor javadoc

我有一个类的两个构造函数,并向它们两个都添加了JavaDoc注释,但是两个构造函数之间只有细微的差别,我想知道它们是否是对两个都使用相同的JavaDoc注释的一种方式,然后添加变成一个。

这里是一个示例(简体)

/**
 * Car constructor
 * @param name Name of car
 * @param make Make of car
 */
public Car(String name, String make) {
    this.name = name;
    this.make = make;
}

/**
 * Car constructor
 * @param make Make of car
 */
public Car(String make) {
    this.name = "EXAMPLE";
    this.make = make;
}

我可以同时使用相同的JavaDoc吗?它们是可行的方法吗?显然,在此示例中,这不是问题,因为它们只有2个字段,但是当使用带有更多对象的类手动编写所有JavaDoc时,这是一个耗时的练习。

0 个答案:

没有答案