|
@deprecated
API Elemente, die nicht mehr benutzt werden sollten, werden mit @deprecated gekennzeichnet.
|
Syntax und Scope
|
|
Syntax
|
@deprec[ated] label
|
|
Scope
|
class, function, var, module, define, use
|
Dem Tag @deprec folgt ein frei definierbares, mehrzeiliges Label.
Das Format des Labels sollte in den eigenen Coding Conventions festgelegt werden.
Es wird vorgeschlagen, eine Versionsnummer, optional gefolgt von einem Minuszeichen
und einer Datumsangabe, in der gleichen Zeile zu notieren: @deprec[ated] version [- yyyy/mm/dd].
Das Format sollte identisch mit dem von @since sein.
|
Codebeispiel
|
/**
* Nikolaus fällt aus.
*
* @deprec 2.1 - 2000/12/06
* @access public
*/
function dontUseMeAnyMore() {
print "Don't use me any more. I have been deprecated.";
}
|
|
Generierte Dokumentation
|
|
|
Public Method Details |
dontUseMeAnyMore |
|
public void dontUseMeAnyMore( )
|
| |
Nikolaus fällt aus.
|
| Returns |
void |
| Deprecated |
2.1 - 2000/12/06 |
|
|
|
