wake-up-neo.net

Wie konfiguriere ich die Javadoc-Vorlagen von Intellij Idea?

Ich habe eine Methode:

public int getSomeField()

Ich möchte Javadoc so generieren:

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

Wo {someField} ist ein Platzhalter für den Feldnamen. Es ist möglich, diese Vorlagen für Intellij Idea zu erstellen (möglicherweise als Live-Vorlage).

javaintellij-ideajavadocauto-generatelive-templates
21
Cherry

Rufen Sie das Menü "Generieren" auf (Cmd + N unter Macintosh, Alt + Einfügen unter Windows).

 Generate menu

Klicken Sie auf die Ellipse in der oberen rechten Ecke.

 Generate Getters menu

Klicken Sie auf das Plus in der oberen linken Ecke und erstellen Sie eine neue Vorlage .  Create new template dialog

Kopieren Sie den Inhalt der alten Vorlage in die neue Vorlage und fügen Sie die folgenden Zeilen oben hinzu.

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

 enter image description here

Wenn Sie jetzt den Getter generieren, verwenden Sie die 'New Template' und Sie sollten sich mit dem JavaDoc vertraut machen.

 Select New Template

 enter image description here

22
Will Humphreys

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

Es wurde am folgenden Tag eine Meldung veröffentlicht: http://youtrack.jetbrains.net/issue/IDEA-28206

9
maba

Dies wird Sie am besten dorthin bringen.

File | Settings... | Live Templates

Drücken Sie das grüne Plus, um eine neue benutzerdefinierte Vorlage hinzuzufügen.

Abkürzung: getter

Vorlagentext:

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

Anwendbar in Java: declaration.

Geben Sie getter ein, an dem Sie eine Methode ausführen möchten, und tab, um die Methode abzuschließen.

Das einzige Manko ist, dass ich nicht weiß, wie man das erste Zeichen von $FIELD$ in get$FIELD$ großschreibt, aber keinen der anderen Orte.

Hier ist ein Bild als Referenz:

IntelliJ Template "getter"

7
kuporific

Wenn Sie das JavaDoc generieren möchten, nachdem die Methode geschrieben wurde (mithilfe von /**), besteht zurzeit keine Möglichkeit, dies anzupassen. Stimmen Sie für Ausgabe IDEA-97658: Vorlage für Javadoc-Stub bearbeiten , wenn Sie möchten, dass dies implementiert wird.

1
Sebastian

Natürlich können Sie eine Live-Vorlage für ein solches Javadoc hinzufügen. Am einfachsten ist es, den gesamten Kommentar auszuwählen und die Aktion "Als Live-Vorlage speichern" (Menü "Extras") aufzurufen. Siehe http://www.jetbrains.com/phpstorm/webhelp/creating-and-editing-live-templates.html für weitere Details.

0
Peter Gromov

Ich habe den Ausdruck methodName () ausprobiert, aber dies funktioniert nur, wenn Sie sich innerhalb einer Methode befinden.

0
Steef