How to generate javadoc comments in Android Studio

I can't find any shortcut to generate javadoc comments. But if you type /** before the method declaration and press Enter, the javadoc comment block will be generated automatically.

Read this for more information.


To generatae comments type /** key before the method declaration and press Enter. It will generage javadoc comment.

Example:

/**
* @param a
* @param b
*/

public void add(int a, int b) {
    //code here
}

For more information check the link https://www.jetbrains.com/idea/features/javadoc.html


Here is an example of a JavaDoc comment from Oracle:

/**
 * Returns an Image object that can then be painted on the screen. 
 * The url argument must specify an absolute {@link URL}. The name
 * argument is a specifier that is relative to the url argument. 
 * <p>
 * This method always returns immediately, whether or not the 
 * image exists. When this applet attempts to draw the image on
 * the screen, the data will be loaded. The graphics primitives 
 * that draw the image will incrementally paint on the screen. 
 *
 * @param  url  an absolute URL giving the base location of the image
 * @param  name the location of the image, relative to the url argument
 * @return      the image at the specified URL
 * @see         Image
 */
 public Image getImage(URL url, String name) {
        try {
            return getImage(new URL(url, name));
        } catch (MalformedURLException e) {
            return null;
        }
 }

The basic format can be auto generated in either of the following ways:

  • Position the cursor above the method and type /** + Enter
  • Position the cursor on the method name and press Alt + Enter > click Add JavaDoc enter image description here