添加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
 */

另一种添加javadocs注释的方法是按下:Ctrl + Shift + A >>显示一个弹出>>类型:添加javadocs >> Enter。 Ctrl +衬衫+ A:命令查找(自动补全命令名)

您可以通过“Fix doc comment”使用eclipse风格的JavaDoc注释生成。 打开“Preference”->“Keymap”，并将“Fix doc comment”动作分配给一个你想要的键。

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

因为我们几乎都使用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(...