java - 如何配置 Intellij Idea javadoc 模板？

Question

我有一些方法：

public int getSomeField()

我想像这样生成javadoc：

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

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

score 27 · Accepted Answer

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

单击右上角的省略号。

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

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

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

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

score 9 · Accepted Answer

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

不幸的是，模板无法更改，并且有这样的要求：http: //youtrack.jetbrains.net/issue/IDEA-28206

score 8 · Accepted Answer

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

File | Settings... | Live Templates

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

缩写：getter

模板文字：

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

适用于 Java declaration：.

键入getter您要使用方法的位置并tab完成。

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

这是一张图片供参考：

IntelliJ 模板

score 2 · Accepted Answer

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

score 0 · Accepted Answer

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

score 0 · Accepted Answer

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

score 0 · Accepted Answer

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

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

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

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

7 回答 7