IDEA-generate Javadoc external documentation
-
In IDEA, click Tools -> Generate JavaDoc , which will open the configuration page for generating javadoc documents.
-
To configure:
The important parts are marked, from top to bottom are the scope of configuring javadoc, output folder path and command line parameters.
The command line parameters here are very important, because only using utf-8 encoding can ensure that Chinese characters can be processed normally when generating, so be sure to add:
-encoding utf-8 -charset utf-8
You can also configure which annotations need to be generated, which permission classes (private, package, protected, public) need to be generated, and other fine-grained controls.
Another point to note is that do not check "Include test sources". After checking, it will cause very strange errors when generating.
- After configuration, click the Generate button, and it will be automatically opened in the browser for viewing after generation:
