我可以在Android工作室使用快捷键来生成javadoc评论吗?
如果不是,生成javadoc注释的最简单方法是什么?
我可以在Android工作室使用快捷键来生成javadoc评论吗?
如果不是,生成javadoc注释的最简单方法是什么?
当前回答
我推荐了带有注释的生成javadoc的Dokka
其他回答
在Android studio中,我们有几种自动生成评论的方法:
我的方法:
通过输入/**,然后按Enter,你可以生成下一个评论行,它会自动生成参数,等等,但当你需要热键为这个签出方法II在下面。
**方法二: **
1 - 转到顶部菜单
2 -文件>设置
3 -在“设置”中选择“Keymap”
4 -在右上角搜索栏搜索“Fix Doc”
5 -从结果中选择“fix doc comment”,双击它
6 -双击后,从打开的下拉菜单中选择“添加键盘快捷方式”
7—按键盘上的快捷键
8 -转到你的代码,在你想添加一些注释的地方按快捷键
9 -好好享受!
简单地选择(即点击)方法名称,然后使用Alt+Enter组合键,选择“添加JavaDoc”
这假设您还没有在方法上面添加注释,否则“Add JavaDoc”选项将不会出现。
我不确定我完全理解了这个问题,但是可以在这里找到一个键盘快捷键的列表-希望这对你有帮助!
因为我们几乎都使用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(...
下面是一个来自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