NetBeans can help us with generating a starting point for Javadoc documentation. Suppose we have the following simple Java class:
package javaapplication16; public class Main { public static void main(String[] args) { final Main app = new Main(); app.sayHello("mrhaki"); } public void sayHello(final String name) { System.out.println("Hello " + name); } }
We right-click on the Sources Packages and select Tools | Analyze Javadoc.
![](https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEgrv-1_q6PU_A-FBhbwZFv8ok2dr_BLU6qXN_kCx9arin3R5oWYdRDr4rRr7cf9DXqncXjic8Nc7ZswfMNaUwWx2uEpBWcNpo1F4Bhd_VcqOrUZoSKAVPGvf-BP7i4PqXQpqaxYqjYJUvFx/s320/javadoc1.png)
NetBeans generates a list of all sources files with missing javadoc in the Analyzer window:
![](https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEh7PQKVIpxejVufV4OFpafCihg3CwmJo7elNAH8lpMcFGkutBzJP4jS9pyvZqru0YeSlPhqPu5oj-RWkDgCKyCrEK9PrD3Dfj2MisJDpMB1zRHKcywvYhHLBBkzfOZjdqFDXbEE8vWTgFzv/s320/javadoc2.png)
We select the files and methods and then hit the Fix Selected button to let NetBeans generate skeleton javadoc code:
package javaapplication16; /** * * @author mrhaki */ public class Main { /** * * @param args */ public static void main(String[] args) { final Main app = new Main(); app.sayHello("mrhaki"); } /** * * @param name */ public void sayHello(final String name) { System.out.println("Hello " + name); } }
Now all we have to do is provide meaningful documentation.