Javadoc: package.html or package-info.java

by

When trying to create package level Javadoc comments, whats the preferred method? What do you do?

package-info.java

  • Pros
    • Newer
  • Cons
    • Abuse of a class – Classes are for code, not for only comments

package.html

  • Pros
    • HTML extension means its not code
    • Syntax highlighting in IDE’s/text editors
  • Cons
    • None?

For me, I’ve always used Package.html. But I’m wondering if its the correct choice.

1 Answer
1

Leave a Comment