1. class
  2. Alvine
  3. \
  4. Development
  5. \
  6. Upkeep
  7. \
  8. Representation
  9. \
  10. Part
  11. \
  12. Comment
  13. \
  14. ClassComment

ClassComment

class ClassComment extends Method

ClassComment

Constants

VISIBILITY_PROTECTED

geschützt
VISIBILITY_PRIVATE

private
VISIBILITY_PUBLIC

öffentlich

Properties

protected string $name from Part
protected string $description from Part
protected Tag> $tags from Method

Methods

string|null
getName()

Name des Bestandteils

from Part
Part
setName(string $name)

Name des Bestandteils setzen

from Part
Part
setDescription(string $description)

Beschreibung setzen

from Part
null
getDescription()

Beschreibung

from Part
string
getToken()

Leere Zeichenkette

from Method
__construct(string $comment)

Neues Objekt

from Method
Tag>
getTags()

Im Kommentar enthaltene Tags

from Method
Method
addTag(Tag $tag)

Tag hinzufügen

from Method
boolean
hasTag(Tag $tag)

Prüfen ob Tag vorhanden

from Method
Method
parse(string $comment)

Kommentar parsen und Tags extrahieren

from Method

Details

in Part at line 73
string|null getName()

Name des Bestandteils

Return Value

string|null Name

in Part at line 84
Part setName(string $name)

Name des Bestandteils setzen

Parameters

string $name Name

Return Value

Part

in Part at line 96
Part setDescription(string $description)

Beschreibung setzen

Parameters

string $description Beschreibung

Return Value

Part

in Part at line 106
null getDescription()

Beschreibung

Return Value

null Beschreibung

in Method at line 165
string getToken()

Leere Zeichenkette

Return Value

string Token

in Method at line 51
__construct(string $comment)

Neues Objekt

Parameters

string $comment Kommentar

in Method at line 65
Tag> getTags()

Im Kommentar enthaltene Tags

Return Value

Tag> Tags

in Method at line 76
Method addTag(Tag $tag)

Tag hinzufügen

Parameters

Tag $tag

Return Value

Method

in Method at line 94
boolean hasTag(Tag $tag)

Prüfen ob Tag vorhanden

Diese Methode prüft, ob die Zeichenkette die ein Tag repräsentiert bereits in der Tagliste enthalten ist. Es wird nicht das Objekt, sondern die Zeichenrepräsentation verglichen.

Parameters

Tag $tag Tag

Return Value

boolean Ergebnis

in Method at line 110
protected Method parse(string $comment)

Kommentar parsen und Tags extrahieren

Parameters

string $comment Kommentar

Return Value

Method