Parent issue: #19807
Coverage table
Chapter link
Content
Image
Text
Template for package.html source file
At Oracle, we use the following template, Empty Template for Package-Level Doc Comment File, when creating a new package doc comment file. This contains a copyright statement. Obviously, if you are from a different company, you would supply your own copyright statement. An engineer would copy this whole file, rename it to package.html, and delete the lines set off with hash marks: #####. One such file should go into each package directory of the source tree.
Guidelines
One such file should go into each package directory of the source tree
This guideline is enforced through the use of JavadocPackage, which checks that each Java package has a package-info.java or package.html file. Proposal:
| Documentation Comments Rule |
Checkstyle Checks Used |
Sample files |
Template for package.html source file |
✅JavadocPackage |
|
Parent issue: #19807
Coverage table
Chapter link
Content
Image
Text
Template for package.html source file
At Oracle, we use the following template, Empty Template for Package-Level Doc Comment File, when creating a new package doc comment file. This contains a copyright statement. Obviously, if you are from a different company, you would supply your own copyright statement. An engineer would copy this whole file, rename it to package.html, and delete the lines set off with hash marks:
#####. One such file should go into each package directory of the source tree.Guidelines
This guideline is enforced through the use of JavadocPackage, which checks that each Java package has a package-info.java or package.html file. Proposal:
Template for package.html source file