如何在Android Studio中生成javadoc注释

Question

我可以在Android工作室中使用快捷键生成javadoc评论吗？

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

Answer 1

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

阅读this了解详情。

Answer 2

要在方法声明之前生成注释类型/**，请按Enter。它将生成javadoc注释。

示例：

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

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

有关详细信息，请查看链接 https://www.jetbrains.com/idea/features/javadoc.html

Answer 3

以下是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;
        }
 }

基本格式可以通过以下任一方式自动生成：

• 将光标放在方法上方，然后输入/** + 输入
• 将光标置于方法名称上，然后按 Alt + Enter ＆gt;单击“添加JavaDoc”

Answer 4

您可以从Settings-＆gt; Plugin-＆gt;浏览存储库安装JavaDoc插件。

从以下链接获取插件文档

JavaDoc plugin document

Answer 5

您可以通过“修复文档注释”使用eclipse风格的JavaDoc注释生成。 打开“偏好” - ＆gt; “键盘映射”并将“修复文档注释”操作分配给您想要的键。

Answer 6

我们可以在这里找到类似的东西。 而不是使用任何捷径我们可以写＆＃34;默认＆＃34;课程/包/项目级别的评论。并根据要求进行修改

   *** 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.

创建评论栏

Answer 7

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

Answer 8

在Android Studio中，您不需要插件。在Mac上只需打开Android Studio - ＆gt;点击顶部栏中的Android Studio - ＆gt;点击Prefrences - ＆gt;在列表中找到文件和代码模板 - ＆gt;选择包括 - ＆gt;构建它并将在所有项目中持久化

Answer 9

只需选择（即点击）方法名称，然后使用组合键Alt + Enter，选择＆＃34;添加JavaDoc＆＃34;

这假设您尚未在方法上方添加注释，否则＆＃34;添加JavaDoc＆＃34;选项不会出现。

Answer 10

在Android工作室中，我们几乎没有办法自动生成评论：

• 方法I：

输入/ **然后按Enter键可以生成下一个注释行，它会自动生成参数等，但是当您需要热键时，请查看下面的方法II。

• **方法II：**

1 - 转到topMenu

2 - 文件＆gt;设置

3 - 从设置

中选择键盘映射

4 - 在右上方的搜索栏中搜索＆＃34;修复文档＆＃34;

5 - 选择＆＃34;修复文档评论＆＃34;从结果中双击它

6 - 双击

后，从打开的下拉列表中选择添加键盘快捷键

7 - 按键盘上的快捷键

8 - 转到您的代码以及要添加注释的位置按快捷键

9 - 享受！

Answer 11

• 添加java文档评论的另一种方法是按： Ctrl + Shift + A ＆gt;＆gt;显示弹出窗口＆gt;＆gt;类型：添加javadocs＆gt;＆gt;输入。

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

Answer 12

只需在Keymap设置中选择Eclipse版本的键帽。 Android Key中包含Eclipse Keymap。

Answer 13

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

Answer 14

Android Studio - ＆gt;偏好 - ＆gt;编辑 - ＆gt;意图 - ＆gt; Java - ＆gt;声明 - ＆gt;启用＆＃34;添加JavaDoc＆＃34;

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

Answer 15

我推荐Dokka来生成带有注释和更多内容的javadoc

Answer 16

添加 Javadoc

• /** + 返回
• 在方法名中设置光标 -> ⌥ Option + return -> 添加 Javadoc

Answer 17

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