web-dev-qa-db-fra.com

Comment configurer les modèles javadoc Intellij Idea?

J'ai une méthode:

public int getSomeField()

Je veux générer javadoc comme ceci:

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

Où {someField} est un espace réservé pour le nom du champ. Il est possible de créer ces modèles pour Intellij Idea (peut être en tant que modèle actif)?

javaintellij-ideajavadocauto-generatelive-templates
21
Cherry

Affichez le menu Générer (Cmd + N sur Mac, Alt + Insérer sous Windows).

 Generate menu

Cliquez sur les ellipses dans le coin supérieur droit.

 Generate Getters menu

Cliquez sur le plus dans le coin supérieur gauche et créez un nouveau modèle .  Create new template dialog

Copiez le contenu de l'ancien modèle dans le nouveau et ajoutez les lignes suivantes en haut.

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

 enter image description here

Maintenant, lorsque vous générez le getter, utilisez le "Nouveau modèle" et vous devriez obtenir votre getter avec JavaDoc.

 Select New Template

 enter image description here

22
Will Humphreys

Vygenerujete Javadoc umístěním caret nad metodu. Potom zadejte /** a stiskněteEnter.

Šablonu bohužel nelze a existuje požadavek, à propos de: http://youtrack.jetbrains.net/issue/IDEA-28206

9
maba

Cela vous mènera presque tout le chemin.

File | Settings... | Live Templates

Appuyez sur le signe plus vert pour ajouter un nouveau modèle personnalisé.

Abréviation: getter

Modèle de texte:

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

Applicable en Java: declaration.

Tapez getter où vous voudriez une méthode et tab complète.

Le seul inconvénient est que je ne sais pas comment faire en sorte que le premier caractère de $FIELD$ soit en majuscule dans get$FIELD$, mais aucun des autres emplacements.

Voici une image pour référence:

IntelliJ Template "getter"

7
kuporific

Si vous souhaitez générer le JavaDoc après que la méthode ait été écrite (à l'aide de /**), il n'existe actuellement aucun moyen de le personnaliser. Votez pour le numéro IDEA-97658: Modifiez le modèle pour le stub javadoc si vous souhaitez voir ceci implémenté.

1
Sebastian

Vous pouvez sûrement ajouter un modèle en direct pour ce type de javadoc. Le moyen le plus simple consiste à sélectionner le commentaire dans son ensemble et à invoquer l'action "Enregistrer en tant que modèle dynamique" (menu Outils). Voir http://www.jetbrains.com/phpstorm/webhelp/creating-and-editing-live-templates.html pour plus de détails.

0
Peter Gromov

J'ai essayé l'expression methodName (), mais cela ne fonctionne que dans une méthode, vous voulez la méthode en dehors de celle-ci, dans le javadoc.

0
Steef