`-Block und das `

new klasse() - Object

` vollständig. * Alle `

`-Methodenblöcke liegen direkt innerhalb von `

`, übersichtlich gruppiert nach thematischen `

`-Zwischenüberschriften. * In der Sidebar entfällt `

new klassenname()

` und `

Statisch

`. Stattdessen spiegeln die `

`-Kategorien direkt die thematischen Überschriften wider (z. B. `

Kalender & Datum

`). * **Namespaces in Header, Signatur & Sidebar:** * **Header:** Vollständige Angabe des Namespace im Dateititel, z. B. `

Kalender - (time\calendar.class.php)

`. * **Signatur:** Voll qualifizierter statischer Klassenaufruf in der Signatur: `static time\calendar::getEasterDate (...)`. * **Sidebar:** Um Platz in der 300px breiten Sidebar zu sparen und Zeilenumbrüche zu vermeiden, wird der Namespace im Linktext weggelassen: `calendar::getEasterDate` bzw. bei Objektmethoden nur der Methodenname wie `add`. --- ## 3. Dokumentation von Konstanten & Eigenschaften 📋 ### A. Konstanten Konstanten stehen vor dem `

`-Block in einer Tabelle mit der Klasse `select`: ```html

`CONST MAXMULTIQUERY = 30`	maximale Anfragen an die Datenbank
`CONST CHARSETDEFAULT = 'utf8'`	Standard Charset

``` ### B. Eigenschaften (`new Class() - Object`) Eigenschaften werden innerhalb des `

`-Blocks in einer `` definiert: * **Schreibgeschützt / Read-Only (🔒):** `$string db = null` *(Das CSS erzeugt über `code.safe::after` automatisch das Schloss-Symbol `\1F512`.)* * **Persistiert / Gespeichert (💾):** `...` *(Das CSS erzeugt über `code.save::after` automatisch das Disketten-Symbol `\1F4BE`.)* * **Schreibbar (via `__set`):** `$string table = null` (ohne `safe`-Klasse). > [!IMPORTANT] > **Nur echte Properties dokumentieren:** > Es dürfen nur Eigenschaften aufgeführt werden, die in `__get()` tatsächlich als Property existieren. Reine Hilfsmethoden wie `isValid(): bool` gehören **nicht** als Property `$bool valid` in diese Tabelle, sondern als eigene Methode! ### C. Komplexe Array-Eigenschaften & semantische Tags Wenn eine Eigenschaft ein assoziatives Array kapselt (z. B. `$specification` in `db.class.php`, `$language` in `lang.class.php` oder `$description` in `charset.class.php`), wird dessen Struktur nicht als Fließtext gequetscht, sondern als sauberer mehrzeiliger Block mit `
` unter der Beschreibung formatiert: ```html ``` * **Strikte Nutzung von `` und ``:** Der gesamte Array-Block muss zwingend in `[ ... ]` gewickelt werden (Lila: `#6f0193`). Alle String-Werte müssen in `'...'` stehen (Grün: `#008705`). * **Keine unformatierten `

`-Tags:** Nackte `['a' => 'b']`-Tags ohne semantische Tags werden vom CSS nicht gefärbt und bleiben dunkelgrau. Auch in ``- oder `

$array language = null assoziatives Array mit Sprachübersetzungen aus der XML-Definition
[ 'de' => 'Deutsch', 'en' => 'German', 'context' => 'language name' ]

`-Texten müssen Code-Snippets entweder vollständig semantisch gewickelt sein (`['wert']`) oder im Fließtext schlicht als Fettdruck stehen (`'wert'`). --- ## 4. Dokumentation von Methoden (`

`) ⚙️ Jede Methode erhält eine eigene `

` mit eindeutiger ID: ```html

methodenName ($typ $param[, $typ $optional = default])

`$param`	Beschreibung des Parameters; Pflicht
`$optional`	optional; Beschreibung des optionalen Parameters

gibt true bei Erfolg zurück; im Fehlerfall null


    $obj = new klasse();

    $obj->methodenName('wert');

``` --- ## 5. Die BNF-Klammerkonvention für Parameter 🔤 In den Signaturen (`

`) gilt eine strikte Regel für eckige Klammern:

1. **Ohne eckige Klammern = Pflichtparameter:**
   * Parameter, die beim Aufruf zwingend erforderlich sind, stehen frei ohne eckige Klammern:
     `createRow ($array $values = null)`
     `real_escape_string ($string $numeric $value = null)`
2. **In eckigen Klammern `[, ...]` = Optionale Parameter:**
   * Parameter, die weggelassen werden können, werden in eckige Klammern gefasst.
3. **Verschachtelte Klammern bei stufenweiser Optionalität:**
   * Wenn Parameter 2 nur übergeben werden kann, wenn Parameter 1 gesetzt ist:
     `createCol ($string $column = null[, $string $setup = null[, $string $after = null]])`
4. **Spezialfälle / Mehrere Pflicht-Inputs (`getRow`):**
   * Wenn ein Aufruf in der Praxis beide Parameter benötigt (z. B. SQL-Logik `SELECT` gefolgt von `WHERE`), werden keine eckigen Klammern gesetzt, um Syntax-Verwirrung zu vermeiden:
     `getRow ($array $string $select = null, $array $string $where = null)`

---

## 6. Der CSS/JS-Kindselektor-Trick (``) 💡

### Problem
In `global.js` durchsucht ein Skript alle Elemente mit der Klasse `.select` und ersetzt Schlüsselwörter (wie `$string`, `$array`, `$bool`, `static`, `public`) automatisch durch:
* `$string` (Datentyp)
* `static` (Sichtbarkeit/Modifikator)

Wenn nun ein **Variablenname** oder ein **Methodenname** zufällig genauso heißt wie ein Typ oder Status-Wort (z. B. die Variable `$string` oder die Methode `static`), würde das JS auch den Namen als Typ/Status einfärben!

### Die Lösung
In `global.css` greifen die Formatierungsregeln mit dem **direkten Kind-Selektor** (`>`):
```css
code > span.type {
  color: var(--textColor4); /* Blau für Typen */
}

code > span.status {
  color: var(--textColor5); /* Rot für Status/Sichtbarkeit */
}
```

Wickelt man den Variablennamen oder Methodennamen im HTML in ein neutrales ``:

**1. Für Datentypen (`` – Blau wird verhindert):**
```html
beispiel ($string $string = null)
```
Macht `global.js` daraus:
```html
... $string ...
```
Dadurch ist `` kein *direktes* Kind von `` mehr. Die Typ-Farbe greift **nicht**, und der Variablenname behält seine normale goldene Textfarbe!

**2. Für Modifikatoren / Status (`` – Rot wird verhindert):**
```html
static doc::static ([$bool $new = null])
```
Macht `global.js` daraus:
```html
... static ...
```
Dadurch ist `` kein *direktes* Kind von `` mehr. Die Status-Farbe greift **nicht**, und der Methodenname behält seine normale goldene Textfarbe!

> [!TIP]
> **Bevorzugte Lösung (Weg A):**
> Am besten werden Kollisionen von vornherein durch **sprechende Parameternamen** vermieden (z. B. `$numbers`, `$elements`, `$items`, `$value`, `$data`, `$other` statt `$array` oder `$string`). So liest sich die Dokumentation natürlicher, und es sind keine zusätzlichen ``-Elemente nötig!
>
> **Die vollständige Keyword-Blacklist aus `global.js`:**
> * **Typen (`selectVar`):** `CONST`, `$string`, `$integer`, `$numeric`, `$float`, `$array`, `$mixed`, `$object`, `$func`, `$bool`, `$resource`
> * **Modifikatoren (`selectStatus`):** `public`, `protected`, `private`, `static`
>
> Diese Bezeichner dürfen niemals als alleiniger Variablenname verwendet werden, da sie sonst von `global.js` automatisch als Typ oder Modifikator eingefärbt werden.

---

## 7. Semantische Highlighting-Tags in Beispielen & Tabellen 🎨

In Codeblöcken (``) innerhalb von ``, Tabellenzellen (`

`) und Beschreibungen (`

`) wird kein externes Highlighting verwendet, sondern semantische Custom-Tags: | Tag | Bedeutung | Farbe / Stil | Beispiel | | :--- | :--- | :--- | :--- | | `` | Variablen | Orange (`#dd7000`) | `$db` | | `` | Funktionen / Methoden | Gold / Ocker (`#a58100`) | `query()` | | `` | Zeichenketten | Grün (`#008705`) | `'test'` | | `` | Arrays / Indizes | Lila (`#6f0193`) | `['a' => 1]` | | `` | Zahlenwerte | Blau (`#0006c9`) | `42` | | `` | Konstanten | Dunkelrot (`#870000`) | `MAXMULTIQUERY` | | `