JavaDoc: where to add notes/remarks to documentation?

后端 未结 4 1897
轮回少年
轮回少年 2021-02-06 20:50

When coding in C# I have always found the tag remarks very useful for providing notes about the implementation of a class or method, or to give information about th

4条回答
  •  伪装坚强ぢ
    2021-02-06 21:50

    If you think implementation details are interesting enough to be a part of the Javadoc, you should simply provide them in a paragraph in the Javadoc comment itself:

    /**
     * Does something.
     * 

    * Implementation details:
    * Blah blah blah... *

    */ public void doSomething() { // ... }

提交回复
热议问题