用于私有(private)/ protected 方法的 JavaDoc？

Question

关闭。这个问题是 opinion-based .它目前不接受答案。

---

想要改进这个问题吗？ 更新问题，以便 editing this post 提供事实和引用来回答它.

关闭 8 年前。

Improve this question

我应该为 private 还是 protected 方法编写 JavaDoc？那么私有(private)变量呢？

我在我的 Java 书上看到了类示例，并且 private 变量是 JavaDoc 的。所以我不明白JavaDoc private(或protected)方法是否是一个好习惯。

Answer 1

是的，您应该为私有(private)方法编写 JavaDoc，即使它只是为您自己编写的。 3 年后，当您必须更改代码时，您会很高兴将其记录在案。

如果您离开公司，或者必须从事另一个项目，您的同事会很高兴拥有文档化的代码。未记录的代码的值(value)要低得多。

看看真正的专业人士是如何做到的。以下是 Sun Microsystems 的 ArrayList 类源代码的摘录:

 /**
  * The array buffer into which the elements of the ArrayList are stored.
  * The capacity of the ArrayList is the length of this array buffer.
  */
  private transient Object[] elementData;