PHPDoc - http://www.phpdoc.de/
 
@return

@return beschreibt den Rückgabewert einer Funktion.

Syntax und Scope
Syntax @return (object objectname|type) [$varname] [description]
Scope function

Wird bei für Funktion kein Rückgabewert angegeben, so wird void angenommen. Bei Konstruktoren wird unabhängig von der Dokumentation void angegeben - eine Fehldokumentation wird an dieser Stelle erkannt.

PHPDoc führt keinen Vergleich des dokumentierten Rückgabewertes mit dem Sourcecode durch. Es ist unwahrscheinlich, daß zukünftige Versionen den Rückgabewert analysieren.

Codebeispiel
 
class returndemo {
  
  /**
  * Liefert einen String.
  *
  * @return string  String ohne sinnvollen Inhalt
  */
  function getString() {
    return "string";
  }
	
  /**
  * Liefert irgendeinen Wert unterschiedlichen Typs.
  *
  * Vorgeschlagener Name: $varname.
  *
  * @return mixed  $varname  Zufälliger Wert unterschiedlichen Typs
  */
  function getMixed() {
    return (rand(0, 1)) ? chr(rand(13, 255)) : rand(0, 1000);
  }
	
  /**
  * Liefert ein Objekt vom Typ returndemo
  * 
  * @return object returndemo  Instanz der Klasse returndemo
  */
  function getReturndemoObject() {
    return new returndemo;
  }
	
}
Generierte Dokumentation
File: c:/www/apache/doc2//bla/return.php
PHPDoc -

returndemo

returndemo

 

private class returndemo

 

Private Method Summary

string

getString()

Liefert einen String.
mixed

getMixed()

Liefert irgendeinen Wert unterschiedlichen Typs.
object [returndemo]

getReturndemoObject()

Liefert ein Objekt vom Typ returndemo

Private Method Details

getString

private string getString( )

  Liefert einen String.

Returns string

String ohne sinnvollen Inhalt


getMixed

private mixed getMixed( )

  Liefert irgendeinen Wert unterschiedlichen Typs.

Vorgeschlagener Name: $varname.

Returns mixed $varname

Zufälliger Wert unterschiedlichen Typs


getReturndemoObject

private object [returndemo] getReturndemoObject( )

  Liefert ein Objekt vom Typ returndemo

Returns object [returndemo]

returndemo $returndemo Instanz der Klasse returndemo


 
Inhalt << @parameter  |  @see >>

 @copyright Ulf Wendel <ulf.wendel@phpdoc.de>, @sponsored by NetUSE AG