在Android Studio中如何生成javadoc注释

Question

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

如果不能，那么最简单的生成Javadoc注释的方法是什么？

- qinxianyuzou

---

这个问题是50/50的。你要么是在寻找单个的javadoc块，要么是在整个文档中生成javadoc。那么你需要哪一个呢？ - basickarl

ALTR + ENTER 显示您可以生成已声明方法注释的视图。 - Zala Janaksinh

也许你应该为此添加一个Live模板（Android Studio - 设置 - 编辑器 - Live Templates - 添加）。在模板文本字段中添加以下文本。 /**

• $comment$ */

- Johnett Mathew

Answer 1

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

点击此处获取更多信息。

- DouO

---

很遗憾这个功能不能用于生成类、字段等的javadoc注释。如果它可以从可定制模板生成javadoc就更好了。 - Ted Hopp

当然有快捷方式：定位到方法/构造函数名称并按下alt+enter，从菜单中选择生成javadoc。 - Ewoks

有关上述解决方案的更多信息，请参阅此处。 - Pritesh Vishwakarma

@Ewoks 对我来说不起作用。 - AndreKR

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

- Amey Haldankar

---

就我所知，仅从评论示例 (在答案中) 上看是有用的，当一个人想快速得到答案时。 - CJBS

实际上，这个例子在最后一个 / 前缺少一个 *。 - Maximiliano Ambrosini

Kotlin支持：https://dev59.com/61kR5IYBdhLWcg3w9Rut。 - CoolMind

Answer 3

这里是一个来自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

- Suragch

---

我来这里是因为我在PhpStorm中知道了这种方法，但在Android Studio中它不起作用。 - AndreKR

救了我的一天！！！谢谢 @Suragch - KK_07k11A0585

有没有快捷方式可以为类中的所有方法添加Javadoc？ - KK_07k11A0585

Answer 4

你可以从“设置->插件->浏览存储库”中安装JavaDoc插件。

从下面的链接获取插件文档。 JavaDoc插件文档

- darwin

---

这很有效。安装JavaDoc插件（如上所述），然后按下CNTL + SHIFT + ALT + G。 - Alan Nelson

有关Kotlin的内容，请参考以下链接：https://kotlinlang.org/docs/reference/kotlin-doc.html - darwin

对于Kotlin：https://dev59.com/questions/61kR5IYBdhLWcg3w9Rut。 - CoolMind

Answer 5

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

- Kuldeep Kumar

Answer 6

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

- Kohei Mikami

Answer 7

在这里，我们可以像这样写一些内容。而不是使用任何快捷方式，我们可以在类/包/项目级别编写“默认”注释。然后根据需要进行修改。

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

好处是，您可以一次为所有方法创建评论块。

- Mr.India

Answer 8

在Android Studio中，您不需要插件。在Mac上打开Android Studio，点击顶部栏中的Android Studio，选择“Preferences”，在列表中找到“File and Code Templates”，选择“includes”，构建它并将其持久保存在所有项目中。

- Robert Warren

Answer 9

• 添加 JavaDocs 注释的另一种方法是按下： Ctrl + Shift + A >> 弹出一个窗口 >> 输入：Add javadocs >> Enter。

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

- huu duy

Answer 10

添加Javadoc

• /** + return
• 将光标置于方法名内 -> ⌥ Option + return -> 添加Javadoc

- yoAlex5