【问题标题】:How to set JavaDoc to update automatically when I change the method signature in Android Studio or IntelliJ IDEA当我在 Android Studio 或 IntelliJ IDEA 中更改方法签名时,如何将 JavaDoc 设置为自动更新
【发布时间】:2016-11-17 15:37:38
【问题描述】:

当我将返回值添加到之前无效的方法时,有没有办法更新 JavaDoc 并添加额外的相应标签。这样,JavaDoc 将在我们更改代码时更新。

This related question 6 年前问过日食,但还没有答案。正如它在 cmets 中所说的那样,它与重构名称无关。

 /**
 * Some explanation about method.
 *
 * @return (I want this tag to be added automatically after I add return type "int" to method)
 */
private int ourMethod() {
    int price = quantity * 5;
    return price;
}

【问题讨论】:

    标签: java android android-studio intellij-idea javadoc


    【解决方案1】:

    我发现这也很有用。

    "Fix doc comment" 是一种为方法自动添加 JavaDoc 的简单有用的方法。在 Keymap 设置中分配一个快捷方式(例如 alt+shift+0)并在插入符号位于方法内时点击它,它还会根据您刚刚所做的更改更新当前的 JavaDoc,并在 JavaDoc 中移动插入符号以使事情变得更容易.

    【讨论】:

    • 按 Ctrl+Shift+A,插入应记录在文档中的类、方法、函数或字段中的某处,然后输入操作名称 Fix Doc String。
    • @okwap 谢谢!无论如何,它是“修复文档评论”,只是为了记录。
    【解决方案2】:

    从 2016.2 版开始,IntelliJ IDEA 中没有任何功能可以在您更改方法的返回类型时为其添加 @return 标记。

    对于参数,如果您使用“更改签名”重构,它将为新参数添加@param标签,为您删除的参数删除它们,并为您重命名的参数更新它们。 Rename 重构也会重命名@param 标签。

    【讨论】:

      【解决方案3】:

      据我所知,没有通过更改方法来添加 JavaDoc 的自动方法。但是,您可以通过在方法顶部开始输入 /** 并按 Enter 来完成。然后自动插入参数和返回值。

      【讨论】:

        猜你喜欢
        • 1970-01-01
        • 1970-01-01
        • 2019-11-30
        • 2022-11-24
        • 1970-01-01
        • 1970-01-01
        • 2011-09-20
        • 2011-12-17
        • 2017-10-23
        相关资源
        最近更新 更多