java - 如何指定out和in参数？

Question

我正在编写一些 javadoc，并且想知道如何强调输出参数。

我目前正在这样做(非常简单)

/**
 * @param cl        (IN Parameter)  description here <br/>
 * @param nodes     (OUT Parameter) description here <br/>
 * @param holotypes (OUT Parameter) description here <br/>
 */
public void getNodes(List<O> cl, List<Node<O>> nodes, List<O> holotypes) {...}

Answer 1

严格来说，您无法在 Java 中实现 OUT 参数。所有参数都是 IN 并按值传递...其中值是引用类型的引用。

在您的示例中，参数似乎的行为与 OUT 参数非常相似，因为它们是可变集合。但这是一种幻觉。例如:

    res = null;
    make(res);
    assert res != null;  // this would succeed with a real OUT parameter

    public void make(List<String> p /* OUT parameter */) {
        p = new ArrayList<String>();
    }

现在，如果您想在项目文档中将这些参数标记为“IN”和“OUT”参数，那就没问题(前提是您清楚地记录了标签的含义)。

但是您通常不会在 javadoc 中看到这个术语，因为严格来说，相对于至少从 1970 年代以来在比较编程语言类(class)中教授的标准术语来说，它是不正确的。