Ich habe das Script aus IPS_GetFunctionList: IP-Symcon :: Automatisierungssoftware zur Umwandlung ins PHP-Doc-Format und Ausgabe in eine Datei umgeschrieben. PHPDoc ist DER Standard für PHP-Entwicklerdocumentation. Damit habe ich auch meine Scripte (meistens) dokumentiert. Bei der Gelegenheit bekommt man beiläufig auch noch die Intellitipps für Ultraedit.
Diese Liste könnte man auch Prima zur Komplettdokumentation der Funktionen einsetzen, um das Thema mal endgültig zu „erschlagen“.
Jetzt fehlt für die Funktionsbeschreibung nur noch ein Tag „FunctionDescription“, und bei den Parametern einen Tag „Parametername“ statt Description einfügen und in dem dann freien Tag Description die Langbeschreibung einfügen. All das könnte man gleich im Sourcecode unterbringen. Dann kann man auch keine Doku mehr vergessen., deren nachträgliche Erstellung zudem auch immer schwer fällt.
Beispiel Ausgabe:
/**
* AC_DeleteVariableData
*
* @returns boolean
* @param integer $InstanceID
* @param integer $VariableID
* @param float $StartTime
* @param float $EndTime
*/
function AC_DeleteVariableData($InstanceID,$VariableID,$StartTime,$EndTime) {
}
/**
* AC_GetAggregatedValues
*
* @returns array
* @param integer $InstanceID
* @param integer $VariableID
* @param integer $AggregationType
* enum[0=Hour, 1=Day, 2=Week, 3=Month, 4=Year]
* @param float $StartTime
* @param float $EndTime
* @param integer $Limit
*/
function AC_GetAggregatedValues($InstanceID,$VariableID,$AggregationType,$StartTime,$EndTime,$Limit) {
}
siehe http://www.tdressler.net/ipsymcon/funktionsliste.html
Tommi
