generate - ¿Cómo configurar las plantillas Intellij Idea javadoc?

intellij javadoc author

Question

Tengo algún método:

public int getSomeField()

Quiero generar javadoc así:

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

Donde {someField} es el marcador de posición para el nombre del campo. ¿Es posible crear estas plantillas para Intellij Idea (puede ser como plantilla en vivo)?

Answer 1

Esto te llevará la mayor parte del camino allí.

File | Settings... | Live Templates

Presiona el signo más verde para agregar una nueva plantilla personalizada.

Abreviatura: getter

Texto de la plantilla:

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

Aplicable en Java: declaration .

Escriba getter donde se completaría un método y una tab .

El único inconveniente es que no sé cómo hacer que el primer carácter de $FIELD$ capitalice en get$FIELD$ pero ninguna de las otras ubicaciones.

Aquí hay una imagen de referencia:

Answer 2

Intenté la expresión methodName (), pero esto solo funciona mientras se está dentro de un método, quieres que el método esté fuera de él, en el javadoc.

Answer 3

Muestra el menú Generar (Cmd + N en Mac, Alt + Insertar en Windows)

Haga clic en los puntos suspensivos en la esquina superior derecha.

Haga clic en el signo más en la esquina superior izquierda y cree una nueva plantilla.

Copie el contenido de la plantilla antigua en la nueva plantilla y agregue las siguientes líneas en la parte superior de la misma.

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

Ahora, cuando genere el getter, use la ''Nueva plantilla'' y debería obtener su getter con el JavaDoc.

Answer 4

Seguramente puede agregar una plantilla en vivo para tal javadoc. La forma más fácil de hacerlo es seleccionar todo el comentario e invocar la acción "Guardar como plantilla en vivo" (menú Herramientas). Consulte http://www.jetbrains.com/phpstorm/webhelp/creating-and-editing-live-templates.html para obtener más detalles.

Answer 5

Si desea generar el JavaDoc después de escribir el método (usando /** ), actualmente no hay manera de personalizarlo. Vote por el número IDEA-97658: edite la plantilla para el código auxiliar de javadoc si desea ver esto implementado.

Answer 6

Usted genera Javadoc colocando el cursor por encima del método. Luego escribe /** y presiona Enter .

Desafortunadamente, la plantilla no se puede cambiar y hay una solicitud para eso: http://youtrack.jetbrains.net/issue/IDEA-28206