228

我可以在 Android Studio 中使用快捷键生成 javadoc 注释吗?

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

4

19 回答 19

418

我找不到任何生成 javadoc 注释的快捷方式。但是如果你/**在方法声明之前输入,然后回车,就会自动生成javadoc注释块。

阅读内容以获取更多信息。

于 2013-06-28T01:33:54.843 回答
120

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

例子:

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

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

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

于 2014-12-09T12:54:51.317 回答
42

以下是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 在此处输入图像描述
于 2017-02-08T03:30:25.250 回答
17

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

从以下链接获取插件文档

JavaDoc 插件文档

在此处输入图像描述

于 2016-04-19T11:03:23.933 回答
12

可以使用 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
 */
于 2018-09-08T14:21:11.220 回答
10

您可以通过“修复文档注释”使用 Eclipse 样式的 JavaDoc 注释生成。打开“首选项”->“键盘映射”并将“修复文档注释”操作分配给您想要的键。

于 2015-03-27T20:14:53.397 回答
9

在这里我们可以做一些这样的事情。我们可以在类/包/项目级别编写“默认”注释,而不是使用任何快捷方式。并按要求修改

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

于 2016-03-02T12:32:10.757 回答
5

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

于 2014-06-03T20:43:38.727 回答
2
  • 添加 java 文档注释的另一种方法是按:Ctrl + Shift + A >> 显示弹出窗口 >> 输入:添加 javadocs >> Enter。

  • Ctrl + Shirt + A:命令查找(自动完成命令名称)

在此处输入图像描述

于 2015-11-13T08:13:50.693 回答
2

添加 Javadoc

  • /**+return
  • 在方法名称中设置光标 -> ⌥ Option+ return-> 添加 Javadoc
于 2021-05-30T14:29:09.103 回答
2

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

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

于 2016-09-01T19:10:52.950 回答
2

在 Android Studio 中,我们有几种方法可以自动生成评论:

  • 方法一:

通过键入 /** 然后按 Enter,您可以生成下一个注释行,它将自动生成参数等,但是当您需要下面的此签出方法 II 的热键时。

  • **方法二:**

1 - 转到顶部菜单

2 - 文件 > 设置

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

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

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

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

7 - 按键盘上的快捷键

8 - 转到您的代码并在您要添加评论的地方按快捷键

9 - 享受!

于 2018-03-01T08:44:58.740 回答
1

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

于 2014-02-11T17:03:42.757 回答
1

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

于 2019-10-14T02:29:09.767 回答
0

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

于 2013-06-25T07:49:58.510 回答
0

因为我们几乎都在使用,您可以使用插件Kotlin生成 JavaDoc (KDoc) 。在 Android Studio 中打开(按++ ),选择并找到. 我下载了 KDoc-er,但你可以选择其中任何一个。然后重启 Android Studio。SettingsCtrlAltSPluginskdoc

查找任何类/方法,键入/**,然后按Enter。你会得到一个简短的描述,如:

/**
 * User data
 *
 * @property name
 * @property avatar
 * @property gender
 * @constructor Create empty User data
 */
class UserData(...

在此处输入图像描述

于 2021-10-12T21:12:33.020 回答
0

Android Studio -> Preferences -> Editor -> Intentions -> Java -> Declaration -> Enable "Add JavaDoc"

并且,在选择实现方法 (Ctrl/Cmd + i) 时,您应该会在左下角看到启用 Copy JavaDoc 的复选框。

于 2018-05-31T08:18:34.677 回答
-1

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

于 2021-10-16T15:57:51.810 回答
-5

ALT++将为您的方法创建自动生成的注释(将光标放在方法的起始位置)SHIFTG

于 2015-03-12T12:52:21.600 回答