如何配置 Intellij Idea javadoc 模板？

Question

我有一些方法：

public int getSomeField()

我想像这样生成javadoc：

/**
* Gets {someField}
*
* @return value of {someField}
*/

其中 {someField} 是字段名称的占位符。 是否可以为 Intellij Idea 创建此模板（可能作为实时模板）？

Answer 1

调出生成菜单（Mac 上为 Cmd+N，Windows 上为 Alt+Insert）

单击右上角的省略号。

单击左上角的加号并创建一个新模板。

将旧模板的内容复制到新模板中，并将以下几行添加到其顶部。

/**
* Gets $field.name
*
* @return value of $field.name
*/

现在，当您生成 getter 时，请使用“新模板”，并且您应该使用 JavaDoc 获取您的 getter。

Answer 2

您可以通过将插入符号放在方法上方来生成 Javadoc。 然后输入/**并按Enter 。

不幸的是，模板无法更改，有一个请求：http: //youtrack.jetbrains.net/issue/IDEA-28206

Answer 3

这将使您大部分时间都在那里。

File | Settings... | Live Templates

按绿色加号添加新的自定义模板。

缩写： getter

模板文本：

/**
 * Gets $FIELD$
 *
 * @return value of $FIELD$
 */
public $RET$ get$FIELD$()
{
    $END$
}

适用于 Java： declaration 。

在方法和tab完成的位置键入getter 。

唯一的缺点是我不知道如何在get$FIELD$中使$FIELD$的第一个字符大写，但其他位置都不大写。

这是一张图片供参考：

Answer 4

如果您想在编写方法后生成 JavaDoc（使用/** ），目前没有办法自定义它。 为问题IDEA-97658投票：如果您希望看到此实现，请编辑 javadoc 存根的模板。

Answer 5

当然，您可以为此类 javadoc 添加实时模板。 最简单的方法是选择整个评论并调用“另存为实时模板”操作（工具菜单）。 有关更多详细信息，请参阅http://www.jetbrains.com/phpstorm/webhelp/creating-and-editing-live-templates.html 。

Answer 6

我尝试了 methodName() 表达式，但这仅在方法内部有效，您希望该方法在方法之外，在 javadoc 中。

Answer 7

为了完整起见，要以类似的方式更改 setter 模板，您可以添加以下内容：

/**
 * Sets $field.name
 *
 * @param $paramName value of $field.name
 */

在#set($paramName = $helper.getParamName($field, $project))行之后。

这将考虑来自项目配置的潜在参数前缀/后缀规则。