【问题标题】:How to generate javadoc comments in Android Studio如何在 Android Studio 中生成 javadoc 注释
【发布时间】:2013-06-21 22:08:31
【问题描述】:

可以在Android studio中使用快捷键生成javadoc cmets吗?

如果没有,生成 javadoc cmets 的最简单方法是什么?

【问题讨论】:

  • 这个问题是 50/50。您正在寻找在整个文档中生成 javadoc 的单个 javadoc 块。是哪个?
  • ALTR + ENTER 显示您可以生成已声明方法的注释的视图。
  • 也许你应该为它添加一个 Live 模板(Android 工作室 - 设置 - 编辑器 - Live Templates - 添加)。在模板文本字段中添加以下文本。 /** * $comment$ */

标签: android-studio javadoc


【解决方案1】:

我找不到任何生成 javadoc cmets 的快捷方式。但是如果在方法声明前输入/**回车,会自动生成javadoc注释块。

阅读this了解更多信息。

【讨论】:

  • 遗憾的是,这也不能为类、字段等生成 javadoc cmets。如果它从可自定义的模板生成 javadoc 会更好。
  • 当然有快捷方式:在方法/构造函数名称上定位并按alt+enter,选择generate javadoc from menu
  • 参考this更多关于上述解决方案
【解决方案2】:

要生成 cmets,请在方法声明前键入 /** 键,然后按 Enter。它将生成 javadoc 注释。

例子:

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

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

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

【讨论】:

  • @satheeshwaran - 真的吗?这与来自 DouO 的答案(原始答案)相同,但它有一个示例。连链接都是副本。该示例应该刚刚添加到原始答案中。
  • @satheeshwaran - 就其价值而言,我可以看到,只要看到 cmets 的示例(在答案中)是有用的,当人们想要快速得到答案时 ;-)
  • 其实这个例子在最后一个/之前缺少一个*
【解决方案3】:

这里是an example of a JavaDoc comment from Oracle

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

【讨论】:

    【解决方案4】:

    您可以从 Settings->Plugin->Browse repositories 安装 JavaDoc 插件。

    从以下链接获取插件文档

    JavaDoc plugin document

    【讨论】:

    【解决方案5】:

    可以使用 IDE 的自动完成功能自动附加 Javadoc cmets。尝试输入 /** 并点击 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
     */
    

    【讨论】:

      【解决方案6】:

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

      【讨论】:

        【解决方案7】:

        在这里我们可以做一些这样的事情。 我们可以在类/包/项目级别编写“默认”cmets,而不是使用任何快捷方式。并按要求修改

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

        优点是,你可以为all the methods at a time.创建评论块

        【讨论】:

          【解决方案8】:

          在 Android Studio 中,您不需要插件。在 Mac 上,只需打开 Android Studio -> 单击顶部栏中的 Android Studio -> 单击首选项 -> 在列表中查找文件和代码模板 -> 选择包含 - > 构建它并将在您的所有项目中持续存在

          【讨论】:

            【解决方案9】:
            • 另一种添加 java 文档注释的方法是按下:Ctrl + Shift + A >> 显示一个弹出窗口 >> 输入:添加 javadocs >> 回车。

            • Ctrl + Shirt + A:命令查找(自动完成命令名称)

            【讨论】:

              【解决方案10】:

              只需选择(即单击)方法名称,然后使用组合键 Alt+Enter,选择“添加 JavaDoc”

              这假定您尚未在方法上方添加 cmets,否则“添加 JavaDoc”选项将不会出现。

              【讨论】:

                【解决方案11】:

                在 Android Studio 中,我们有几种方法可以自动生成 cmets:

                • 方法一:

                通过输入 /** 然后按 Enter,您可以生成下一个注释行,它会自动生成参数等,但是当您需要下面的此签出方法 II 的热键时。

                • **方法二:**

                1 - 转到顶部菜单

                2 - 文件 > 设置

                3 - 从设置中选择键盘映射

                4 - 在右上角的搜索栏搜索“Fix Doc”

                5 - 从结果中选择“修复文档注释”并双击它

                6 - 双击后从打开的下拉菜单中选择添加键盘快捷键

                7 - 按键盘上的快捷键

                8 - 转到您的代码并在您要添加评论的地方按快捷键

                9 - 享受吧!

                【讨论】:

                • 添加文档最方便的方式。例如。我已指定“'”并 Enter 作为快捷方式
                【解决方案12】:

                添加 Javadoc

                • /** + 返回
                • 在方法名中设置光标-> ⌥ Option + return -> 添加Javadoc

                【讨论】:

                  【解决方案13】:

                  只需在 Keymap 设置中选择 Eclipse 版本的键帽即可。 Android Studio 中包含一个 Eclipse Keymap。

                  【讨论】:

                    【解决方案14】:

                    我推荐 Dokka 用于生成带有注释和更多内容的 javadoc

                    【讨论】:

                      【解决方案15】:

                      我不确定我是否完全理解这个问题,但可以找到键盘快捷键列表here - 希望这会有所帮助!

                      【讨论】:

                      • 在eclipse中添加javadoc cmets按Alt+shift+j,但是在AndroidStudio中却不知道怎么做
                      • 如果我记得,该快捷方式只有在您安装并启用了“jautodoc”插件时才有效。
                      【解决方案16】:

                      Android Studio -> Preferences -> Editor -> Intentions -> Java -> Declaration -> Enable "Add JavaDoc"

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

                      【讨论】:

                        【解决方案17】:

                        因为我们几乎都使用Kotlin,所以您可以生成JavaDoc (KDoc) using plugins。在 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(...
                        

                        【讨论】:

                          【解决方案18】:

                          生成 javadoc 注释使用 /** 您的文档 */

                          【讨论】:

                          • 这已经在其他答案中被提及并详细解释过在回答已有答案的旧问题时,请确保提供新颖的解决方案或比现有答案更好的解释。
                          【解决方案19】:

                          ALT+SHIFT+G 将为您的方法创建自动生成的 cmets(将光标放在方法的起始位置)。

                          【讨论】:

                          • public void hideKeyboard() 你应该把光标放在public前面试试看,或者请检查你是否在你的工作室安装了java文档。
                          • 它也不适合我。也许,它正在一些特殊的键盘映射中工作。可以在 Preferences > Keymap 中配置键盘映射。或者键盘映射已被编辑。
                          猜你喜欢
                          • 2016-07-14
                          • 1970-01-01
                          • 1970-01-01
                          • 2010-12-19
                          • 2011-08-02
                          • 2012-09-16
                          • 1970-01-01
                          • 2023-03-30
                          • 1970-01-01
                          相关资源
                          最近更新 更多