有没有办法说明将应用于Javadoc中的方法参数的更改？

Question

想象一下将更改应用于参数化对象的方法。例如，传递了地图或列表。

如果开发人员决定不创建并返回参数的副本，我想最好在此方法的Javadoc中注明通知，并指示这些更改的参数。

我可以想到一个替代的@param标签，比如@varparam或@refparam（关于其他编程语言的pass-by-reference关键字）。

问题是：在Javadoc中有没有通用的方法来做这些提示？将更改应用于参数有多常见？我想这可能是经常出现的问题。

Answer 1

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

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