想象一个将更改应用于参数化对象的方法。例如传递的 map 订单列表。
如果开发人员决定不创建并返回参数的副本，我想最好在 Javadoc 中对此方法和指示这些更改的参数进行通知。
我可以想到一个替代的@param标签，例如@varparam或@refparam(关于其他编程语言的按引用传递关键字)。
问题是:在 Javadoc 中是否有通用的方法来执行这些提示？对参数进行更改有多常见？我想这可能是一个经常出现的问题。
最佳答案
没有特殊的标签来表示这一点；公认的做法是在描述部分明确说明该方法修改参数对象。
尽管有些人不喜欢这种代码风格，但 java core 中有一些常见的方法可以做到这一点。我想到了java.util.Arrays.sort(以及Collections中的类似方法)。
关于java - 有没有办法在 Javadoc 中声明将应用于方法参数的更改？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/40423900/