如何配置Intellij Idea javadoc模板？

我有一些方法：

public int getSomeField() 

我想像这样生成javadoc：

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

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

Answer 1

打开Generate菜单（Mac上的Cmd + N，Windows上的Alt + Insert）

单击右上角的省略号。

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

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

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

现在，当你生成getter时，使用’New Template’，你应该得到你的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 。

键入getter ，您可以在其中完成方法和tab 。

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

这是一张图片供参考：

Answer 4

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

Answer 5

我尝试了methodName（）表达式，但这只适用于方法内部，你需要在javadoc之外的方法。

Answer 6

如果要在编写方法后生成JavaDoc（使用/** ），则目前无法自定义此方法。 问题投票IDEA-97658：编辑javadoc存根的模板，如果你想看到这个实现。