有没有一种方法可以声明将应用于 Javadoc 中的方法参数的更改?

Is there a way to state changes that will be applied to method parameters within Javadoc?

想象一个将更改应用到参数化对象的方法。例如通过了一个地图订单列表。

如果开发人员决定不创建和 return 参数的副本,我想最好在 Javadoc 中通知此方法和指示这些更改的参数。

我可以想到一个替代的@param 标记,如@varparam 或@refparam(关于其他编程语言的传递引用关键字)。

问题是:在 Javadoc 中是否有一种通用的方法来执行这些提示?对参数应用更改有多常见?我想这可能是一个经常出现的问题。

没有特殊的标签表示这个;公认的做法是在描述部分明确说明该方法修改了参数对象。

虽然有些人不喜欢这种代码风格,但 java 核心中有一些常用方法可以做到这一点。想到 java.util.Arrays.sort(以及 Collections 中的类似方法)。