java - Kotlin:属性 setter 的文档

Question

我正在编写一个 Kotlin 库。在其中一门课中，我有以下内容:

class SessionWrapper {

    /**
     * The time in milliseconds after which the session will expire.
     */
    var expiryTime = DEFAULT_EXPIRY_TIME
        get() {
            mainThreadCheck()
            return field
        }
        set(value) {
            mainThreadCheck()
            field = value
            updateExpiry(value) <<< THIS ONE
        }

    ...
}

然而，updateExpiry(long) 的行为应该对 SessionWrapper 的客户端是透明的，如果他们修改 expiryTime(即调用二传手)。

现在，对于 Kotlin 项目，这不是问题，因为我可以将额外的 KDoc 添加到 expiryTime 属性本身，并且不会觉得不合适:

    /**
     * The time in milliseconds after which the session will expire.
     *
     * Updating the expiry time after the session is started does x,
     * the listeners will receive y.
     *
     * Writing comments is fun, when the tools work.
     */
     var expiryTime = DEFAULT_EXPIRY_TIME

但是对于 Java 项目，上面的文档会同时出现在 setExpiryTime(long) 和 getExpiryTime() 中，因为我会有 setter JavaDoc在 getter 中，在 setter 中获取 JavaDoc。

尝试在 Kotlin 中以下列方式分离两个访问器的文档:

class SomeClass{

    var expiryTime = DEFAULT_EXPIRY_TIME
        /**
         * The time in milliseconds after which the session will expire.
         */
        get() {
            mainThreadCheck()
            return field
        }
        /**
         * Updating the expiry time after the session is started does x,
         * the listeners will receive y.
         *
         * Writing comments is fun, when the tools work.
         */
        set(value) {
            mainThreadCheck()
            field = value
            updateExpiry(value)
        }

    ...
}

在 IDE 中只显示没有 JavaDoc，对于 Kotlin 和 Java 代码。

我发现没有明确的方法可以尝试在 KDoc reference 中分离 Java 可见的 getter 和 setter 的文档。或 Java interop page .

考虑到 Kotlin 与 Java 的良好互操作性，我觉得这很烦人。

希望有任何想法。

Answer 1

我认为你应该重新评估你的类设计，而不是试图解释文档中的特殊行为。这通常是代码异味的标志，也可能是可测试性差的标志。

您应该牢记 updateExpiry() 的特殊行为对类进行建模。 如果这方面值得对客户端透明，它可能应该是某种接口(interface)或协议(protocol)步骤的一部分。

在不知道软件其余部分的详细信息的情况下，我能想到的最好办法就是将 setter 设为私有(private)并添加一个单独的函数来更新 expiryTime:

/** Explain property */
var expiryTime = DEFAULT_EXPIRY_TIME
    get() {
        mainThreadCheck()
        return field
    }
    private set(value) {
        mainThreadCheck()
        field = value
    }

/** Explain update behavior constraints */
fun updateExpiryTime(value: Any) {
  expiryTime = value
  updateExpiry(value)
}

恕我直言，不应期望 Kotlin 的 Java 互操作性会产生与 Java 代码一样的代码。在字节码层面兼容，不一定是源代码和Javadoc层面。