如何在Android Studio中生成Javadoc注释

我可以在Android Studio中使用快捷键来生成Javadoc注释吗？

如果没有，生成Javadoc注释的最简单方法是什么？

我找不到任何生成javadoc注释的快捷方式。但是，如果/**在方法声明之前键入并按Enter，则将自动生成javadoc注释块。

阅读此以获得更多信息。

要生成注释/**，请在方法声明之前键入key，然后按Enter。它将产生javadoc注释。

例：

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

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

有关更多信息，请检查链接 https://www.jetbrains.com/idea/features/javadoc.html

这是来自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>单击添加JavaDoc

您可以从Settings-> Plugin-> Browse Repository安装JavaDoc插件。

从以下链接获取插件文档

JavaDoc插件文档

您可以通过“修复文档注释”来使用JavaDoc注释生成的eclipse样式。打开“首选项”->“键映射”，然后将“修复文档注释”操作分配给所需的键。

在这里，我们可以像这样。而且我们可以使用类/包/项目级别的“默认”注释来代替使用任何快捷方式。并按要求修改

   *** Install JavaDoc Plugin ***



     1.Press shift twice and  Go to Plugins.
     2. search for JavaDocs plugin
     3. Install it. 
     4. Restart Android Studio.
     5. Now, rightclick on Java file/package and goto 
        JavaDocs >> create javadocs for all elements
        It will  generate all default comments.

好处是，您可以为创建注释块 all the methods at a time.

可以使用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
 */

在Android Studio中，您不需要插件。在Mac上，只需打开Android Studio->单击顶部栏中的Android Studio->单击首选项->在列表中找到文件和代码模板->选择包含->构建它并将在您的所有项目中保持不变

• 添加Java文档注释的另一种方法是：Ctrl + Shift + A >>显示弹出窗口>>类型：添加Javadocs >> Enter。

• Ctrl + Shirt + A：命令查找（自动完成命令名称）

只需选择（即单击）方法名称，然后使用组合键Alt + Enter，选择“添加JavaDoc”

假定您尚未在方法上方添加注释，否则“添加JavaDoc”选项将不会出现。

在Android Studio中，我们很少有自动生成评论的方法：

• 方法一：

通过输入/ **，然后按Enter键，您可以生成下一条注释行，它将自动生成参数等。

• **方法二：**

1-转到顶部菜单

2-文件>设置

3-从设置中选择键盘映射

4-在右上角的搜索栏上搜索“修复文档”

5-从结果中选择“修复文档注释”，然后双击它

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

7-按键盘上的快捷键

8-转到您的代码，然后在要添加注释的位置按快捷键

9-享受！

只需在“键盘映射”设置中选择键帽的Eclipse版本。Eclipse Keymap包含在Android Studio中。

我不确定我是否完全理解该问题，但是可以在此处找到键盘快捷键列表-希望这会有所帮助！

Android Studio->首选项->编辑器->意向-> Java->声明->启用“添加JavaDoc”

并且，在选择实现方法（Ctrl / Cmd + i）的同时，您应该会在左下角看到复选框以启用“复制JavaDoc”。

我推荐Dokka生成带有注释等的javadoc

ALT+ SHIFT+ G将为您的方法创建自动生成的注释（将光标置于方法的开始位置）。