如何配置Intellij Idea的javadoc模板？

Question

我有一些方法：

public int getSomeField()

我想生成类似这样的Javadoc文档：

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

在这里，{someField} 是字段名称的占位符。是否可以为Intellij Idea创建这些模板（可能是作为实时模板）？

- Cherry

---

如果您正在使用Eclipse，我建议使用JAutoDoc。 - mattbdean

Answer 1

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

点击右上角的省略号。

请点击左上角的加号创建一个新模板。 将旧模板的内容复制到新模板中，并在顶部添加以下行。

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

现在，当您生成getter时，请使用“新模板”，然后您应该可以获得带有JavaDoc的getter。

- Will Humphreys

Answer 2

你可以将插入符号放在方法上方来生成Javadoc。 然后输入 /** 并按下 Enter 键即可。不幸的是，模板无法更改，已有人提出了更改请求：http://youtrack.jetbrains.net/issue/IDEA-28206。

- maba

---

现在您可以编辑模板上的评论。请参见下面的答案。https://dev59.com/1WMm5IYBdhLWcg3wdeqa#38094408 - Will Humphreys

Answer 3

这将让你大部分完成。

文件 | 设置... | 实时模板

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

缩写：getter 模板文本：

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

适用于Java：declaration。

在需要方法的地方使用getter并进行tab补全。

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

以下是参考图片：

- kuporific

Answer 4

如果你想在方法编写完成后（使用/**）生成JavaDoc，目前还没有办法定制。如果你希望看到这个功能实现，请投票支持问题IDEA-97658: Edit template for javadoc stub。

- Sebastian

Answer 5

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

- Peter Gromov

Answer 6

我尝试了methodName()表达式，但这只在方法内部起作用，你想要的是在javadoc之外的方法。

- Steef

Answer 7

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

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

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

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

- Cedric Bosdonnat