生成javadoc注释使用 ／** 你的文档 * /

添加Javadoc

/** +返回 在方法名称中设置光标->选项+返回->添加Javadoc

在Android studio中，我们有几种自动生成评论的方法:

我的方法:

通过输入/**，然后按Enter，你可以生成下一个评论行，它会自动生成参数，等等，但当你需要热键为这个签出方法II在下面。

**方法二： **

1 - 转到顶部菜单

2 -文件>设置

3 -在“设置”中选择“Keymap”

4 -在右上角搜索栏搜索“Fix Doc”

5 -从结果中选择“fix doc comment”，双击它

6 -双击后，从打开的下拉菜单中选择“添加键盘快捷方式”

7—按键盘上的快捷键

8 -转到你的代码，在你想添加一些注释的地方按快捷键

9 -好好享受!

下面是一个来自Oracle的JavaDoc注释示例:

/**
 * 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;
        }
 }

基本格式可以通过以下两种方式自动生成:

将光标置于方法上方，并键入/** + Enter 将光标定位在方法名上，按Alt + Enter >，单击Add JavaDoc

可以使用IDE的自动完成功能自动添加Javadoc注释。尝试输入/**并按Enter生成一个示例Javadoc注释。

 /**
 *
 * @param action          The action to execute.
 * @param args            The exec() arguments.
 * @param callbackContext The callback context used when calling back into JavaScript.
 * @return
 * @throws JSONException
 */

您可以通过“Fix doc comment”使用eclipse风格的JavaDoc注释生成。 打开“Preference”->“Keymap”，并将“Fix doc comment”动作分配给一个你想要的键。