it-swarm.com.de

Wie passe ich NetBeans an? PHP Auto DocBlock für Methoden und Attribute?

Nachdem ich eine Methode erstellt habe, benutze ich /**<enter>, um den DocBlock zu generieren. Es füllt automatisch den @param und den @return für diese Funktion. Beispiel:

/**
 *
 * @param type $str
 * @return type 
 */
public function strlen($str){
    return strlen($str);
}

Wie kann ich den generierten Block so anpassen, dass er auch den @author ausfüllt und am Ende den /**<enter> enthält?

/**
 *
 * @param type $str
 * @return type 
 * @author John Doe <[email protected]>
 */
public function strlen($str){
    return strlen($str);
}

Vielen Dank

33
bxfckrclooo

Es gibt vielleicht eine bessere Möglichkeit, dies zu tun, aber ich habe Folgendes verwendet: Unter Extras> Optionen> Editor> Codevorlagen gibt es einige vordefinierte Kombinationen, um Code schnell zu generieren. Eine der Standardvorlagen in 7.0 ist:

vdoc<tab>

Dies erzeugt einen Pseudo-Doc-Block und die Variablendefinition. Sie können dies ersetzen und neue hinzufügen, die sich in den gewünschten Text einfügen, ähnlich wie bei vim-Abkürzungen. Weitere Informationen hierzu finden Sie auf der Netbeans-Dokumentationssite:

http://netbeans.org/kb/docs/php/code-templates.html#using-templates

5
Bryan Agee

Ich glaube, die Antwort, die Sie suchen, finden Sie hier: phpDocumentor Tutorial

Ich denke, Sie sollten sich den Befehlszeilenschalter --customtags ansehen.

Wenn Sie also zu Extras -> Optionen -> "PHP" -> "PHPDoc" gehen, können Sie höchstwahrscheinlich den Befehlszeilenschalter --customtags in die PHPDoc-Skriptzeile einfügen.

Ich habe es nicht persönlich versucht, aber ich habe mit der Idee herumgespielt, NetBeans in Kombination mit DocBlocks und PHPDocumentor zu verwenden, um "automatisch" eine gute Menge an verwendbarer Dokumentation zu erstellen, ohne zu anstrengend zu sein der Codierer. ;-)

Ein nettes Video-Tutorial zum Einrichten von NetBeans für die Arbeit mit PHPDocumentor finden Sie hier: Generieren von PHP Dokumentation mit NetBeans IDE 7.0

4
russsaidwords

Um die automatische Vervollständigung des @author-Tags zu aktivieren, gehen Sie einfach zu: Extras-> Vorlagen-> PHP-> PHP-Klasse, klicken Sie auf die Schaltfläche "Einstellungen" und kommentieren Sie die Zeile aus, die mit #user= beginnt. Jetzt können Sie den Namen und die E-Mail-Adresse bearbeiten, die an Ihren Klassenkommentar weitergeleitet werden.

3
zinovyev

Kurze Antwort aus verschiedenen Quellen: Nein, Sie können keine Vorlage bearbeiten, die sie für Sie hinzufügen könnte.

  1. Wenn Sie immer noch nach einem ähnlichen Feature suchen, können Sie ein Macro do erstellen und es dann an eine Verknüpfung binden (z. B. "Alt + W").

So erstellen Sie ein Makro : Extras -> Optionen -> Editor -> Makros

Beispiel:

Alt+W => insert-break "/**" insert-break

Dieses Makro hilft, PHPDoc mit der linken Hand hinzuzufügen, was es schneller macht. Sie können mit diesem Makro generieren, was auch immer Sie generieren möchten, und dann den Cursor an der richtigen Stelle platzieren und am Ende des Kommentars das @author YOUR_NAME hinzufügen.


  1. Sie können den allgemeinen Autor Ihres Projekts auch festlegen, indem Sie auf Extras -> Vorlagen gehen. Klicken Sie auf "Einstellungen"

Fügen Sie die Zeile hinzu:

user=YOUR NAME <email.prefix at domain.extension>

Dadurch wird @author zu allen neuen Klassen-/Schnittstellendefinitionen hinzugefügt.

Ich hoffe, dies wird dir helfen!

0
aneth101