Dokumentation von Klassen-Methoden

brain_overload · 07.10.2004, 11:49

Hallo,
ich suche im Grunde nur die richtige Bezeichnung für ein Dokumentation-Problemchen.

Ich möchte in der Dokumentation klar machen, ob eine Klassen-Methode ohne Objekt aufgerufen werden darf oder ob diese Klassen-Methode ein Objekt erfordert.

Code:

// Beispiel
class KLASSE {
  var $foo;
  function get_text() { return "text"; }
  function get_foo() { return $this->foo; }
}

a) Aufruf von KLASSE::get_text() ist erlaubt (ohne Objekt)
b) Aufruf von KLASSE::get_foo() ist nicht erlaubt, weil KLASSE->foo gar nicht ohne Objekt existiert.

Wie kann ich dass in meiner Doku klar machen ?
["Spricht" man hier vielleicht, wie bei lokalen Funktion-Variabeln von static oder nicht static ??]

Waq · 07.10.2004, 11:53

Jepp. Ein Aufruf ohne Objekt ist "static".

07.10.2004, 11:57

hi,

du hast recht so eine methode nennt mann static.

PHP-Code:

  <?php

  /**

  * @author   Foo Bar

  * @version  1.0

  * @package  Foo

  */

 
 
  /**

  * Klasse

  *

  * genauere beschreibung

  *

  * @author   Foo Bar

  * @version  1.0

  * @package  Foo

  */

  class KLASSE {

    /**

    * foo

    *

    * @var      integer

    * @access   public

    * @version  1.0

    */  

    var $foo;

 
    /**

    * kurze beschreibung

    *

    * @access   public

    * @static

    * @version  1.0

    * @returns     string

    */    

    function get_text() { return "text"; }

    

    /**

    * kurze beschreibung

    *

    * @access   public

    * @version  1.0

    * @returns     string

    */    

    function get_foo() { return $this->foo; }

  } 

?>

brain_overload · 07.10.2004, 14:08

Muchas gracias !

Themen-Optionen
Druckbare Version zeigen Jemanden per E-Mail auf dieses Thema hinweisen
Thema bewerten
Thema bewerten:

Ähnliche Themen
Thema	Autor	Forum	Antworten	Letzter Beitrag
UML - Abstrakte und vererbte Methoden zwingend anzugeben?	MaMo-Net	Off-Topic Diskussionen	3	17.03.2008 06:04
Klassen und externe Funktionen ?	ssm	PHP-Fortgeschrittene	17	18.07.2007 11:59
Klassen sinnvoll nutzen, Grundlegendes	nikosch	PHP-Fortgeschrittene	1	30.09.2006 22:08
Fragen zu Klassen	Kein Genie	PHP Tipps 2006	3	08.05.2006 11:25
Sessions an includete Klassen übergeben	Dr_Enquinox	PHP Tipps 2006	4	29.04.2006 10:25
mit html klassen definieren und in php ausgeben		PHP-Fortgeschrittene	4	16.01.2006 10:31
[Erledigt] PHP 4 - Klassen?	patr1k	PHP Tipps 2005	10	18.11.2005 10:48
Klassen	Fatal Error	PHP Tipps 2005-2	3	19.10.2005 15:31
Fehler abfangen in Klassen		PHP Tipps 2005-2	26	25.06.2005 19:26
klassen und methoden anderer klassen in methoden....		PHP Tipps 2005	17	25.05.2005 09:46
Klassen		PHP Tipps 2005	5	09.04.2005 18:51
Klassen in Klassen verwenden		PHP Tipps 2005	5	23.02.2005 14:08
Klassen in PHP		PHP Tipps 2004	4	12.08.2004 13:17
Klassen?!		PHP Tipps 2004	14	03.06.2004 17:33

07.10.2004, 11:49
brain_overload Benutzer Registriert seit: 29.06.2004 Beiträge: 50	Dokumentation von Klassen-Methoden Hallo, ich suche im Grunde nur die richtige Bezeichnung für ein Dokumentation-Problemchen. Ich möchte in der Dokumentation klar machen, ob eine Klassen-Methode ohne Objekt aufgerufen werden darf oder ob diese Klassen-Methode ein Objekt erfordert. Code: // Beispiel class KLASSE { var $foo; function get_text() { return "text"; } function get_foo() { return $this->foo; } } a) Aufruf von KLASSE::get_text() ist erlaubt (ohne Objekt) b) Aufruf von KLASSE::get_foo() ist nicht erlaubt, weil KLASSE->foo gar nicht ohne Objekt existiert. Wie kann ich dass in meiner Doku klar machen ? ["Spricht" man hier vielleicht, wie bei lokalen Funktion-Variabeln von static oder nicht static ??]


Mister Ad PHP Code Flüsterer Registriert seit: 21.08.2005 Beiträge: 4682 PHP-Kenntnisse: Fortgeschritten

07.10.2004, 11:53
Waq Erfahrener Benutzer Registriert seit: 15.08.2004 Beiträge: 2.473	Jepp. Ein Aufruf ohne Objekt ist "static". __________________ mod = master of disaster

07.10.2004, 11:57
Gast Beiträge: n/a	hi, du hast recht so eine methode nennt mann static. PHP-Code: <?php /** * @author Foo Bar * @version 1.0 * @package Foo / /* * Klasse * * genauere beschreibung * * @author Foo Bar * @version 1.0 * @package Foo / class KLASSE { /* * foo * * @var integer * @access public * @version 1.0 / var $foo; /* * kurze beschreibung * * @access public * @static * @version 1.0 * @returns string / function get_text() { return "text"; } /* * kurze beschreibung * * @access public * @version 1.0 * @returns string */ function get_foo() { return $this->foo; } } ?>

07.10.2004, 14:08
brain_overload Benutzer Registriert seit: 29.06.2004 Beiträge: 50	Muchas gracias !