Suche
Suche Menü

PHPDoc Blöcke in Eclipse automatisch einfügen

Bisher habe ich meine PHP Funktionen/Klassen mehr schlecht als recht dokumentiert. Nach einem längeren Gespräch mit einem Kollegen über Sinn und Unsinn von guter Dokumentation, habe ich mich auf die Suche gemacht, wie dies in Eclipse am einfachsten umsetzbar ist.

Eclipse hat dazu eine ganz einfache Funktion, welche den PHPDoc Syntax einfügt. Folgende Zeichenfolge eingeben und danach Enter drücken.

/**

Eclipse fügt damit folgendes ein:

    /**
     *
     * Enter description here ...
     * @param unknown_type $user
     * @param unknown_type $password
     * @param unknown_type $host
     * @param unknown_type $port
     */

Somit muss nur noch die Beschreibung, die Typen der einzelnen Parameter sowie der @return Typ angegeben werden.

Schreibe einen Kommentar

Pflichtfelder sind mit * markiert.