Javadoc: package.html or package-info.java

by

package-info.java: “This file is new in JDK 5.0, and is preferred over package.html.”—javadoc – The Java API Documentation Generator

Addendum: The big difference seems to be package annotations. There’s a little more in the way of rationale in 7.4 Package Declarations.

Addendum: The annotation feature is also mentioned here and in Javadoc tip: Prefer package-info to package.html, cited here.

Addendum: See also What’s package-info.java for?.

More Related Contents:

  1. Maven is not working in Java 8 when Javadoc tags are incomplete
  2. Eclipse: Attach source/javadoc to a library via a local property
  3. Multiple line code example in Javadoc comment
  4. How to generate Javadoc HTML files in Eclipse?
  5. How to see JavaDoc in IntelliJ IDEA? [duplicate]
  6. How to attach source or JavaDoc in eclipse for any jar file e.g. JavaFX?
  7. How to reference a method in javadoc?
  8. How to get a JavaDoc of a method at run time?
  9. /** and /* in Java Comments
  10. How to download Javadoc to read offline? [closed]
  11. How to quote “*/” in JavaDocs
  12. How to create custom javadoc tags?
  13. Obtain and download Javadoc (JDK documentation) to a local file for offline reading
  14. Javadoc reuse for overloaded methods
  15. How to make generated classes contain Javadoc from XML Schema documentation
  16. How do I exclude a specific method/constructor from the results of the javadoc Ant task?
  17. How can I use “” in javadoc without formatting?
  18. Javadoc @author tag good practices
  19. Attaching additional javadoc in Intellij IDEA
  20. How configure Intellij Idea javadoc templates?
  21. A tool to add and complete PHP source code documentation [closed]
  22. How can you escape the @ character in javadoc?
  23. How do I add the Java API documentation to Eclipse?
  24. What is the point of abstract classes, when you could just do an interface [duplicate]
  25. Solve Hibernate Lazy-Init issue with hibernate.enable_lazy_load_no_trans
  26. Java Array HashCode implementation
  27. How to create a class literal of a known type: Class
  28. Sending a message to all clients (Client – Server communication)
  29. How to sort an attribute of an object using Collections
  30. Add ArrayList to another ArrayList in java

Leave a Comment