我可以在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
 */

要在方法声明之前输入/**键并按Enter生成注释。它将生成javadoc注释。

例子:

/**
* @param a
* @param b
*/

public void add(int a, int b) {
    //code here
}

欲了解更多信息,请查看链接 https://www.jetbrains.com/idea/features/javadoc.html

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

并且,当选择方法来实现(Ctrl/Cmd + i),在左下角,你应该看到复选框启用复制JavaDoc。

这里我们可以做一些这样的东西。 而不是使用任何快捷方式,我们可以在类/包/项目级别写“默认”注释。并根据需求进行修改

   *** 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.

优点是,您可以一次为所有方法创建注释块。

下面是一个来自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