我可以在Android工作室使用快捷键来生成javadoc评论吗?
如果不是,生成javadoc注释的最简单方法是什么?
我可以在Android工作室使用快捷键来生成javadoc评论吗?
如果不是,生成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
其他回答
另一种添加javadocs注释的方法是按下:Ctrl + Shift + A >>显示一个弹出>>类型:添加javadocs >> Enter。 Ctrl +衬衫+ A:命令查找(自动补全命令名)
在Android Studio中,你不需要插件。在Mac上,只需打开Android Studio ->单击顶部栏中的Android Studio ->单击preferences ->在列表中找到文件和代码模板->选择包含->构建它,并将在所有项目中持久存在
下面是一个来自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
添加Javadoc
/** +返回 在方法名称中设置光标->选项+返回->添加Javadoc
要在方法声明之前输入/**键并按Enter生成注释。它将生成javadoc注释。
例子:
/**
* @param a
* @param b
*/
public void add(int a, int b) {
//code here
}
欲了解更多信息,请查看链接 https://www.jetbrains.com/idea/features/javadoc.html