PHPDocumentor Docu-Style, used tags

[frankx]

Hellihello dedlfix,

Aus eigener Erfahrung kann ich da nur das Zend Framework anführen. Das hat am Ende der Coding-Style-Dokumentation etwas über die Inline-Dokumentation geschrieben. Sicher braucht man nicht wirklich alle diese Tags. Wesentlich für IDEs mit Codevervollständigung, die dafür auch die PHPDoc-Kommentare heranziehen, sind im Grunde genommen nur @param und @return für die Funktionen/Methoden und @var für Klasseneigenschaften.

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

  
  
<?php  
/**  
 * Short description for file  
 * Using an XSLTprocessor  
 * Long description for file (if any)...  
 *  
 * LICENSE: Some license information  
 *  
 * @copyright  GNU GPL  
 * @license    GNU GPL  
 * @version   My_XSLT 1.0  
 * @link       http://spinneimnetz.de  
 * @since      My_XSLT 1.0  
*/  
  
/**  
 * Short description for class  
 * Process XSLT  
 * Long description for class (if any)...  
 *  
 * @copyright  GNU GPL  
 * @license    GNU GPL  
 * @version    1.0  
 * @link       http://spinneimnetz.de  
 * @since      My_XSLT 1.0  
**/  
  
class My_XSLT  
{  
 /**  
 * @var  string xml-string  
 */  
 private $xml="";  
  
 /**  
 * @var  string xsl-string  
 */  
 private $xsl="";  
  
 /**  
 * @var  string output-string  
 */  
 private $output="";  
  
 /**  
 * description of the function:  
 * reads xml_file and xsl_file and calls {@link process()}  
 * @param  string $file_path_xml file_path_xml  
 * @param  string $file_path_xsl file_path_xsl  
 * @return  boolean success of operation  
 */  
 public function __construct($file_path_xml,$file_path_xsl)  
 {  
   $this->xsl = new DOMDocument();  
  $this->xml = new DOMDocument();  
  if ($this->xml->load($file_path_xml) && $this->xsl->load($file_path_xsl)) {  
   $this->process();  
   return true;  
  } else {  
   return false;  
  }  
 }  
  
 /**  
 * description of the function:  
 *  applies xsl stylesheet to xml-data  
 * @param  string $file_path_xml file_path_xml  
 * @param  string $file_path_xsl file_path_xsl  
 * @return  boolean success of operation  
 */  
 private function process()  
 {  
 $proc = new XSLTprocessor;  
  if ($proc->importStyleSheet($this->xsl) // attach the xsl rules  
   && $this->output = $proc->transformToXML($this->xml)) {  // actual transformation  
   return true;  
  } else {  
   return false;  
  }  
 }  
 /**  
 * description of the function  
 * getter vor transformed xml-string  
 * @return  string transformed xml-string  
 */  
 public function putout()  
 {  
  return $this->output;  
 }  
  
 /**  
 * write transformed xml-string to file  
 * @param  string $file_path_xsl file_path_xsl  
 * @return  boolean success of writing not empty file  
 */  
  
 public function write($file_path_output)  
 {  
  if (file_put_contents($file_path_output,$this->putout())) {  
   return true;  
  } else {  
   return false;  
  }  
 }  
}  
  

?

Dank und Gruß,

frankx