Back

Explore Courses Blog Tutorials Interview Questions
0 votes
2 views
in Java by (10.2k points)

In the Java APIs I can see Javadoc comments for packages.

How/where do I place Javadoc comments to document a package?

1 Answer

0 votes
by (46k points)

As of 1.5 you can define a package-info.java file and provide a standard javadoc style comment for a package:

com/foo/package-info.java:

/**

 * com.foo is a group of bar utils for operating on foo things.

 */

package com.foo;

//rest of the file is empty

Language specification for packages

Related questions

0 votes
1 answer
asked Oct 17, 2019 in Java by Anvi (10.2k points)
0 votes
1 answer
0 votes
1 answer
0 votes
1 answer
asked Aug 25, 2019 in Java by Shubham (3.9k points)
0 votes
1 answer
asked Dec 2, 2019 in Java by Anvi (10.2k points)
Welcome to Intellipaat Community. Get your technical queries answered by top developers!

30.5k questions

32.6k answers

500 comments

108k users

Browse Categories

...