是否有一种方法可以将状态更改应用于Javadoc中的方法参数？

设想一个方法，将更改应用于参数化对象。例如，传递了一个映射排序器列表

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

我可以想到另一个@param标记，比如@varparam或@refparam（关于其他编程语言的passbyreference关键字）

---

问题是：在Javadoc中有没有一种通用的方法来实现这些提示？对参数应用更改有多普遍？我想这可能是一个经常出现的问题。

没有表示这一点的特殊标记；公认的做法是在“描述”部分中明确说明该方法修改参数对象

---

尽管有些人不喜欢这种风格的代码，但java核心中有一些常用的方法可以做到这一点

java.util.array.sort

（以及

集合中的类似方法

）。

没有表示这一点的特殊标记；公认的做法是在“描述”部分中明确说明该方法修改参数对象

---

尽管有些人不喜欢这种风格的代码，但java核心中有一些常用的方法可以做到这一点

java.util.array.sort

（以及

Collections

中的类似方法）。

如果您没有在运行时以某种方式改变自身的代码，那么我不明白为什么当前的标记和选项对您来说还不够？@Tadija Bagarić问题在于它可以很容易地监督，更改应用于参数。原因可能只是坏代码。作为一个修补程序，项目调整Javadoc可能比开始进行重构来消除这种糟糕的方法行为要好。类似地，大约20年前，我提出了一个

@unstable

标记，它的工作原理与

@deprecated

标记类似，但被拒绝了。它会将API标记为仍在开发中，并警告未来可能会有突破性的变化。但是一旦设置了额外的标签，它们就很难再添加这些标签了。@Alvin Thompspn，正如您的回答所指出的，有一些方法使用这种行为是有原因的。一些编程风格可能会以一种有意义的方式使用它。但我想，如果能用一种通用的方式在Javadoc中记录它，那将是一场胜利。这就是为什么我问是否有这样一种常见的方式——可能在任何操作系统项目中，或者我在研究中遗漏了一个标记。如果您没有在运行时会自行变形的代码，那么我不明白为什么当前的标记和选项对您来说还不够？@Tadija Bagarić问题是，它可以很容易地监督，这些更改将应用于参数。原因可能只是坏代码。作为一个修补程序，项目调整Javadoc可能比开始进行重构来消除这种糟糕的方法行为要好。类似地，大约20年前，我提出了一个

@unstable

标记，它的工作原理与

@deprecated

标记类似，但被拒绝了。它会将API标记为仍在开发中，并警告未来可能会有突破性的变化。但是一旦设置了额外的标签，它们就很难再添加这些标签了。@Alvin Thompspn，正如您的回答所指出的，有一些方法使用这种行为是有原因的。一些编程风格可能会以一种有意义的方式使用它。但我想，如果能用一种通用的方式在Javadoc中记录它，那将是一场胜利。这就是为什么我问是否有这样一种常见的方法——可能是在任何操作系统项目中，也可能是我在研究中遗漏了一个标签。