PHP Code richtig kommentieren

Was gibt es für verschiedene Doc Comments um eine übersichtliche API-Dokumentation zu erstellen die jedem helfen? Wie sollte bei einem guten Programmierer der Kommentarkopf über den Klassen und Methoden aussehen?

/**
* Die erste Zeile beschreibt alles kurz mit einem Titel
*
* Dann folgt nach einer Leerzeile dieser dicke fette Block von Kommentarsätzen,
* die das Verhältnis der Klasse oder Methode im Projekt beschreibt.
* Hier drunter werden die Tags eingesetzt, wieder mit einer Leerzeile Abstand.
*
* @author misarah <ich@something>
* @version 2.0 Medieninformatiker Wiese jetzt im neuen Design
* @link https://misarah.wordpress.com Der Blog mit Hintergrundwissen.
*
*/

Verfügbare Tags

  • @abstract
  • @access (public|private)
  • @author Name [E-Mail] [, Name [E-Mail]]
  • @brother (function(), $variable)
  • @const[ant] Beschreibung
  • @deprec[ated] label
  • @exclude label
  • @final
  • @global
  • @include Beschreibung
  • @link URL [Beschreibung]
  • @magic Beschreibung
  • @module label
  • @modulegroup label
  • @param[eter] (objekt objektname|type) [$varname] [Beschreibung]
  • @return (objekt objektname|type) [$varname]
  • @see [(class|module:]function()|$varname [,[(class|module:J]function()|$varname]
  • @since label
  • @static
  • @throws exception [, exception]
  • @todo Beschreibung
  • @var[iable] (objekt objektname|type) [$varname] [Beschreibung]
  • @version label

Zum Nachlesen

PHPDoc

Advertisements

Kommentare

Trage deine Daten unten ein oder klicke ein Icon um dich einzuloggen:

WordPress.com-Logo

Du kommentierst mit Deinem WordPress.com-Konto. Abmelden / Ändern )

Twitter-Bild

Du kommentierst mit Deinem Twitter-Konto. Abmelden / Ändern )

Facebook-Foto

Du kommentierst mit Deinem Facebook-Konto. Abmelden / Ändern )

Google+ Foto

Du kommentierst mit Deinem Google+-Konto. Abmelden / Ändern )

Verbinde mit %s