我可以在Android工作室使用快捷键来生成javadoc评论吗?
如果不是,生成javadoc注释的最简单方法是什么?
我可以在Android工作室使用快捷键来生成javadoc评论吗?
如果不是,生成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
*/
其他回答
我找不到任何生成javadoc注释的快捷方式。但是如果在方法声明之前输入/**并按Enter,则会自动生成javadoc注释块。
阅读这篇文章获取更多信息。
我推荐了带有注释的生成javadoc的Dokka
ALT+SHIFT+G将为您的方法创建自动生成的注释(将光标放在方法的起始位置)。
下面是一个来自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
另一种添加javadocs注释的方法是按下:Ctrl + Shift + A >>显示一个弹出>>类型:添加javadocs >> Enter。 Ctrl +衬衫+ A:命令查找(自动补全命令名)