JavaDoc: where to add notes/remarks to documentation?

Question

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

Answer 1

With iteration 8 of the Java programming language, developers finally have been provided with three additional tags they can use in their code's documentation – and which should meet your needs: @apiNote, @implSpec and @implNote (cf., for instance, for a more detailed discussion: blog.codefx.org/java/new-javadoc-tags/).