2013-07-12 13 views
17

Ich habe einige Methode:Wie konfigurieren Sie Intellij Idea javadoc Vorlagen?

public int getSomeField() 

Ich möchte javadoc wie folgt generieren:

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

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

+0

Wenn Sie Eclipse wurden würde ich empfehlen, [JAutoDoc] (http://jautodoc.sourceforge.net/). – mattbdean

Antwort

5

Sie generieren Javadoc, indem Sie das Caretzeichen oberhalb der Methode platzieren. Dann geben Sie /** ein und drücken Geben Sie ein.

Leider kann die Vorlage nicht geändert werden, und es ist eine Anfrage für das: http://youtrack.jetbrains.net/issue/IDEA-28206

+0

Das verknüpfte Problem ist jetzt als 'behoben' markiert – Gallal

+0

Sie können jetzt Kommentare zu Vorlagen bearbeiten. Siehe die Antwort unten. http://stackoverflow.com/a/38094408/2377639 –

6

Dies wird den größten Teil des Weges dorthin bringen.

File | Settings... | Live Templates

Drücken Sie die grüne und eine neue benutzerdefinierte Vorlage hinzufügen.

Kürzel: getter

Schablonentext:

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

Anwendbar in Java: declaration.

Geben Sie getter, wo Sie eine Methode und tab abgeschlossen wäre.

Das einzige Manko ist, ich weiß nicht, wie man das erste Zeichen von $FIELD$ in get$FIELD$ Groß geschrieben aber keiner der anderen Standorte. Hier

ist ein Bild als Referenz:

IntelliJ Template "getter"

0

ich die Methoden() Ausdruck versucht, aber das funktioniert nur, während innerhalb einer Methode, möchten Sie die Methode außerhalb, in der javadoc.

13

up Bringen Sie das Generieren Menü (Cmd + N auf Mac, Alt + Legen Sie unter Windows)

Generate menu

Klicken Sie auf die Auslassungszeichen in der rechten oberen Ecke.

Generate Getters menu

das Plus in der linken oberen Ecke klicken und eine neue Vorlage erstellen.

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

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

enter image description here

, wenn Sie die Getter Verwendung erzeugen die ‚Neue Vorlage‘ und Sie sollten Ihre Getter mit der JavaDoc bekommen.

Select New Template

enter image description here

+0

Funktioniert wie ein Charme: D – Dr4gon