PHPDocumentor Docu-Style, used tags

[frankx]

Hellihello

echo $begrüßung;

gemäß dem würde es dann in etwa so aussehen?

* @copyright  GNU GPL
* @license    GNU GPL
* @version   My_XSLT 1.0
* @link       http://spinneimnetz.de
* @since      My_XSLT 1.0

Ob du diesen Kladderadatsch brauchst oder haben möchtest, musst du selbst entscheiden.

Naja, wollt mal schauen, wies so geht und was passiert, wenn mans so macht, wie Zend es als obligatorisch angibt. GNU GPL finde ich für die Ergebnisse einer Schul-HTML-Ag zB garnicht so falsch. Wissen die Kinder auch gleich mal, dass es sowas gibt (die, dies noch nicht wissen).

/**
* Short description for class
* Process XSLT
* Long description for class (if any)...

In der ersten Zeile steht eine Kurzbeschreibung.

Statt "Short description for class"

Dann folgt eine Leerzeile gefolgt von einer optionalen Langbeschreibung. Die Kurzbeschreibung wird in Übersichten angezeigt. Da sollte also was Aussagekräftiges drinstehen.

  
  
/**  
* Process XSLT to create xthml from xml using xsl  
*  
* For demonstration purposeses ... and so on and so on  
* see answer to Vinzenz  
  
  

* @param  string $file_path_xml file_path_xml
* @param  string $file_path_xsl file_path_xsl
private function process()

Die Dokumentation passt nicht zur Signatur der Methode. Es ist auch kein func_*_args()-Aufruf in der Funktion zu sehen.

Yes, ein Copy-Paste-Fehler.

  
/**  
* ...  
* nix params  
*/  
  
private function process()  
  
  

Hier noch ein Nicht-PHPDoc-Hinweis:

public function write($file_path_output)
{
  if (file_put_contents($file_path_output,$this->putout())) {
   return true;
  } else {
   return false;
  }
}
}

Wenn die Bedingung im if zutrifft, wird die Funktion aufgrund des return verlassen. Das return false; kann außerhalb des else notiert werden, da es ja in jedem Fall nur beim Nichtzutreffen ausgeführt wird. Obendrein ist hier gar kein if-else notwendig. return file_put_contents(...), zur Not nach boolean gecastet, ergibt das gleiche Ergebnis. Allerdings ist das im Spezialfall "alles i.O. es wurden aber nur 0 Bytes geschrieben" in keinem Fall richtig. return false !== file_put_contents(...); wäre dann genauer.

  
  
public function write($file_path_output)  
{  
  return (false !== file_put_contents($file_path_output,$this->putout());  
}  
  
  

merci und
Dank und Gruß,

frankx