javadoc - 如何记录 Java 副作用

Question

是否有为包含副作用的 Java/JVM 语言方法编写 javadoc 的标准或最佳实践？

我定义了一个 void 方法，它修改了方法参数之一，但不知道如何记录实际返回值(因为没有实际返回)。

/**
  * @param obj - reference object
  * @return obj - obj.name is changed to 'hello' //TODO figure out javadoc annotation
 */
void methodName(Object obj) {
   if (obj != null) {
       obj.name = "hello";
   }
}

似乎没有好的方法来标记对象上的副作用，因为 @param 和 @return 注释并没有真正决定发生了什么。

Answer 1

没有标准的 Javadoc 注释来描述副作用。副作用通常会在人类可读的方法描述中提及。在您的情况下，作为参数传递的对象已被修改，因此您可以考虑在 @param 之后简单地重复副作用。标签。

无论如何，@return标记不是记录副作用的正确位置:您的方法有 void作为返回类型，因此它不返回任何内容。

在您的情况下，您的 Javadoc 可能如下所示:

/**
 * Methods a name. This method sets the "name" attribute of obj to "hello".
 * @param obj reference object ("name" attribute is modified by this method)
 */
void methodName(Object obj) {
   if (obj != null) {
       obj.name = "hello";
   }
}