Funktionsbeschreibungen

[Skaschy]

Hallo,
ich habe gemerkt das ich bei meinen Funktionen langsam durcheinander komme; ~152 in der Zahl!

Nun hab ich mir überlegt wie ich die am sinnvollsten Beschreiben kann.

Hab mal n bissle rum gesurft und bin da auf sowas gestossen:

/**
  * Get the PM-Content by ID  
  *
  * @param int $pid Private message id
  *
  * @return array (
  *        pid          =>        private message id
  *        title        =>        private message title
  *        message      =>        private message
  *        from_userid  =>        userid of the user who send the pm
  *        to_userid    =>        userid of the receiver
  *        send_date    =>        date
  *        send_time    =>        time
  * )
  *
  */
function getPMbyID($pid)
{
    $source = $this->db->sql("SELECT
                                  `pid`, `from_userid`, `to_userid`, `title`, `message`,    
                                  DATE_FORMAT(stamp,'%d.%m.%Y') as send_date,    
                                  DATE_FORMAT(stamp,'%h:$i') as send_time 
                              FROM `".$_SQLTABLE["pm_messages"]."`
                              WHERE `pid` = '".$pid."'");
    $data    = $this->db->fetch_array($source);
    return $data;
} 

Hab damit einfach mal ne Funktion von mir beschrieben.

Was habt Ihr für Vorschläge?

[asp2php]

ist i.O.

**verschieb nach OT** da keine PHP-Probleme

[frabron]

Das ist ja im Stil von phpdocumentor www.phpdoc.org. Ich benutze das auch um meine Projekte zu dokumentieren. Nett ist halt, dass man direkt eine Übersicht, bzw. eine Dokumentation generieren lassen kann.