logo标签列表

在Android Studio中如何生成javadoc注释

android-studiojavadoc
248

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

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

这个问题是50/50的。你要么是在寻找单个的javadoc块，要么是在整个文档中生成javadoc。那么你需要哪一个呢？ - basickarl
1
ALTR + ENTER 显示您可以生成已声明方法注释的视图。 - Zala Janaksinh
也许你应该为此添加一个Live模板（Android Studio - 设置 - 编辑器 - Live Templates - 添加）。在模板文本字段中添加以下文本。 /**
  • $comment$ */
 - Johnett Mathew
19个回答
2

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

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

2
在Android Studio中，我们有几种自动生成注释的方法：
  • 方法一：

通过输入 /** 然后按下 Enter 键，您可以生成下一个注释行，并且它将自动生成参数等。但是，如果您需要此操作的快捷键，请查看下面的方法二。

  • 方法二：

1 - 转到顶部菜单

2 - 文件 > 设置

3 - 从设置中选择键映射

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

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

6 - 从打开的下拉菜单中选择添加键盘快捷方式

7 - 按下键盘上的快捷键

8 - 转到您的代码并在需要添加注释的位置按下快捷键

9 - 尽情享受！

1
最方便的添加文档的方法。例如，我已将“'”和“Enter”分配为快捷键。 - CodeToLife
1
我建议使用Dokka来生成带有注释和更多信息的Java文档。
1

只需在Keymap设置中选择Eclipse版本的按键映射。 Android Studio中已包含Eclipse Keymap。

0

因为我们几乎都使用 Kotlin，所以你可以使用插件生成 JavaDoc（KDoc）。在 Android Studio 中打开设置（按下Ctrl+Alt+S），选择插件并找到kdoc。我下载了{{link2:KDoc-er，但你可以选择任何一个。然后重新启动 Android Studio。

找到任何类/方法，输入/**，按下Enter。你将得到一个简短的描述，如下：

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

enter image description here

0

Android Studio -> 首选项 -> 编辑器 -> 意图 -> Java -> 声明 -> 启用 "添加 JavaDoc"

此外，在选择要实现的方法（Ctrl/Cmd + i）时，在左下角应该看到启用复制 JavaDoc 的复选框。

0

我不确定我完全理解问题，但可以在这里找到键盘快捷键列表 - 希望这能帮到你！

2
在Eclipse中添加javadoc注释，按Alt + shift + j，但在AndroidStudio中我不知道该怎么做。 - qinxianyuzou
如果我没记错的话，那个快捷键只有在你安装并启用了“jautodoc”插件时才能起作用。 - Matt
-1

生成Javadoc注释使用 /** 您的文档 */

这已经在其他答案中被提到并详细解释过了。当回答已有答案的旧问题时，请确保您提供的是新颖的解决方案或比现有答案更好的解释。 - Eric Aya
-5

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

公共的无效隐藏键盘()，您应该将光标放在public前面并尝试它，或者请检查您是否在工作室中安装了Java文档。 - Dinesh IT
对我也不起作用。也许它在某些特殊的键位映射中有效。可以在“首选项 > 键位映射”中配置键位映射。或者键位映射已被编辑过。 - Oliver Kranz
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接