如何配置 Intellij Idea javadoc 模板？答案

【问题标题】：How configure Intellij Idea javadoc templates?如何配置 Intellij Idea javadoc 模板？
【发布时间】：2013-07-10 14:00:25
【问题描述】：

我有办法：

public int getSomeField()

我想像这样生成 javadoc：

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

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

【问题讨论】：

【解决方案1】：

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

很遗憾，模板无法更改，对此有要求：http://youtrack.jetbrains.net/issue/IDEA-28206

【讨论】：

【解决方案2】：

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

【讨论】：

【解决方案3】：

这将使您大部分时间到达那里。

File | Settings... | Live Templates

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

缩写：getter

模板文本：

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

适用于 Java：declaration。

在您要输入方法的地方输入getter，然后输入tab 完成。

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

这是一张图片供参考：

【讨论】：

【解决方案4】：

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

【讨论】：

【解决方案5】：

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

点击右上角的省略号。

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

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

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

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

【讨论】：

【解决方案6】：

如果您想在编写方法后生成JavaDoc（使用/**），目前无法自定义。如果您希望看到这个实现，请投票给问题IDEA-97658: Edit template for javadoc stub。

【讨论】：

【解决方案7】：

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

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

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

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

【讨论】：