我可以在Android工作室使用快捷键来生成javadoc评论吗?
如果不是,生成javadoc注释的最简单方法是什么?
我可以在Android工作室使用快捷键来生成javadoc评论吗?
如果不是,生成javadoc注释的最简单方法是什么?
在Android Studio中,你不需要插件。在Mac上,只需打开Android Studio ->单击顶部栏中的Android Studio ->单击preferences ->在列表中找到文件和代码模板->选择包含->构建它,并将在所有项目中持久存在
要在方法声明之前输入/**键并按Enter生成注释。它将生成javadoc注释。
例子:
/**
* @param a
* @param b
*/
public void add(int a, int b) {
//code here
}
欲了解更多信息,请查看链接 https://www.jetbrains.com/idea/features/javadoc.html
您可以通过“Fix doc comment”使用eclipse风格的JavaDoc注释生成。 打开“Preference”->“Keymap”,并将“Fix doc comment”动作分配给一个你想要的键。
另一种添加javadocs注释的方法是按下:Ctrl + Shift + A >>显示一个弹出>>类型:添加javadocs >> Enter。 Ctrl +衬衫+ A:命令查找(自动补全命令名)
这里我们可以做一些这样的东西。 而不是使用任何快捷方式,我们可以在类/包/项目级别写“默认”注释。并根据需求进行修改
*** 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.
优点是,您可以一次为所有方法创建注释块。
您可以从Settings-> plugin ->Browse repository中安装JavaDoc plugin。
从下面的链接获取插件文档
JavaDoc插件文档
简单地选择(即点击)方法名称,然后使用Alt+Enter组合键,选择“添加JavaDoc”
这假设您还没有在方法上面添加注释,否则“Add JavaDoc”选项将不会出现。
下面是一个来自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 >,单击Add JavaDoc
在Android studio中,我们有几种自动生成评论的方法:
我的方法:
通过输入/**,然后按Enter,你可以生成下一个评论行,它会自动生成参数,等等,但当你需要热键为这个签出方法II在下面。
**方法二: **
1 - 转到顶部菜单
2 -文件>设置
3 -在“设置”中选择“Keymap”
4 -在右上角搜索栏搜索“Fix Doc”
5 -从结果中选择“fix doc comment”,双击它
6 -双击后,从打开的下拉菜单中选择“添加键盘快捷方式”
7—按键盘上的快捷键
8 -转到你的代码,在你想添加一些注释的地方按快捷键
9 -好好享受!
Android Studio ->首选项->编辑器->意图-> Java ->声明->启用“添加JavaDoc”
并且,当选择方法来实现(Ctrl/Cmd + i),在左下角,你应该看到复选框启用复制JavaDoc。
可以使用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
*/
因为我们几乎都使用Kotlin,所以可以使用插件生成JavaDoc (KDoc)。在Android Studio中打开Settings(按Ctrl+Alt+S),选择Plugins并找到kdoc。我下载了KDoc-er,但你可以选择其中任何一个。然后重新启动Android Studio。
找到任何类/方法,键入/**,按Enter。你会得到一个简短的描述:
/**
* User data
*
* @property name
* @property avatar
* @property gender
* @constructor Create empty User data
*/
class UserData(...