Как настроить шаблоны Intellij Idea javadoc?

У меня есть метод:

public int getSomeField()

Я хочу создать javadoc следующим образом:

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

Где {someField} является заполнителем для имени поля. Можно создать эти шаблоны для Intellij Idea (может быть как живой шаблон)?

Ответы

Ответ 1

Поднимите меню "Создать" (Cmd + N на Mac, Alt + Insert в Windows)

Щелкните эллипсис в верхнем правом углу.

Щелкните по плюсу в левом верхнем углу и создайте новый шаблон.

Скопируйте содержимое старого шаблона в новый шаблон и добавьте следующие строки вверху.

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

Теперь, когда вы создаете getter, используйте "Новый шаблон", и вы должны получить свой getter с JavaDoc.

Ответ 2

Это даст вам большую часть пути.

File | Settings... | Live Templates

Нажмите зеленый плюс, чтобы добавить новый настраиваемый шаблон.

Сокращение: getter

Текст шаблона:

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

Применяется в Java: declaration.

Введите getter, где вы выполнили бы метод и tab.

Единственный недостаток - я не знаю, как сделать первый символ $FIELD$ заглавным в get$FIELD$, но ни в одном другом месте.

Вот изображение для справки:

Ответ 3

Вы создаете Javadoc, поместив каретку выше метода. Затем введите /** и нажмите Enter.

К сожалению, шаблон не может быть изменен, и для него есть запрос: http://youtrack.jetbrains.net/issue/IDEA-28206

Ответ 4

Конечно, вы можете добавить живой шаблон для такого javadoc. Самый простой способ сделать это - выбрать весь комментарий и вызвать действие "Сохранить как живой шаблон" (меню "Инструменты" ). Подробнее см. http://www.jetbrains.com/phpstorm/webhelp/creating-and-editing-live-templates.html.

Ответ 5

Я попробовал выражение methodName(), но это работает только внутри метода, вы хотите использовать его вне его в javadoc.