如何在KDoc中引用辅助构造函数?

时间:2019-10-23 16:08:26

标签: kotlin kdoc

我有一个带有辅助构造函数的Kotlin类,应该在某些情况下使用它。现在应该从第一个构造函数中正确记录下来,以便您可以立即看到它。

/**
* This is my class.
* 
* @constructor This is the primary constructor meant for Scenario A.
* If you are in Scenario B, please use [reference to secondary constructor] <- what do I put in here?
*/
class MyClass(val a: String) {

    constructor(b: Int) : this("$b abc")

}

我丝毫不知道在方括号中应放置哪些用于引用成员/函数的内容,但我认为应该可以。 如果有人对此有更多了解,那就太好了

1 个答案:

答案 0 :(得分:1)

您不必引用第二个构造函数,编译器将根据您的参数为您完成此操作。如果您要使用其他构造函数,或者只是使用特定属性,只需创建一个新类,就可以在类声明中使用*来仅使用给定的尽可能多的参数。