C++-Referenz/ Zum Buch/ Design

Alte Seite

Die Arbeit am Buch »C++-Referenz« wurde vom Hauptautor eingestellt. Ein Lehrbuch zum Thema C++ ist unter »C++-Programmierung« zu finden. Eine sehr umfangreiche und gute Referenz gibt es unter cppreference.com.

Vorlagen

Quelltext

Um Quelltext darzustellen, verwenden wir die Vorlage „C++-Referenz: Vorlage:Code“. Sie ist etwas platzsparender als die regalweite Code-Vorlage und besitzt auch nur den Parameter code, da andere Formatierungen in diesem Buch nicht benötigt werden.

{{:C++-Referenz/ Vorlage:Code
|code=<source lang=cpp>
// Header: cstring
int memcmp(void const *buf1, void const *buf2, size_t count);
</source>
}}

---

// Header: cstring
int memcmp(void const *buf1, void const *buf2, size_t count);

---

<source lang=cpp>...</source> ist eine Erweiterung, die Syntaxhervorhebung ermöglicht. Leider ist es zur Zeit aufgrund technischer Einschränkungen noch nicht möglich, das direkt in die Vorlage einzuarbeiten. Für Syntaxhervorhebung im Fließtext wird <source enclose="none" lang="css">...</source> benutzt. Die Syntaxhervorhebung für C++ ist leider noch recht fehlerhaft, aber das wird sich mit der Zeit hoffentlich bessern.

Funktionsparameter und Rückgabe

Die Vorlage „C++-Referenz/ Vorlage:Funktion“ erlaubt es, ihre Parameter und, falls vorhanden, den Rückgabewert zu beschreiben.

{{:C++-Referenz/ Vorlage:Funktion
|buf1| Zeiger auf einen Speicherbereich
|buf2| Zeiger auf einen anderen Speicherbereich
|count| Anzahl der zu vergleichenden Bytes
|return= Nummerischer Wert mit folgender Bedeutung:
* <code>< 0</code>: <code>buf1</code> < <code>buf2</code>
* <code>  0</code>: <code>buf1</code> und <code>buf2</code> sind gleichgroß
* <code>> 0</code>: <code>buf1</code> > <code>buf2</code>
}}

---

Parameter:

• buf1: Zeiger auf einen Speicherbereich

• buf2: Zeiger auf einen anderen Speicherbereich

• count: Anzahl der zu vergleichenden Bytes

Rückgabewert: Nummerischer Wert mit folgender Bedeutung:

• < 0: buf1 < buf2
•   0: buf1 und buf2 sind gleichgroß
• > 0: buf1 > buf2

---

Beschreibungen

Funktionen

Überschrift entsprechender Ordnung: <code>Funktionsname</code>

{{:C++-Referenz/ Vorlage:Code
|code=<source lang="cpp">
// Header: Name der Headerdatei[en]
Funktionsprototyp
</source>
}}

Beschreibung der Funktion

{{:C++-Referenz/ Vorlage:Funktion
|Parametername 1| Beschreibung des Parameters
|Parametername 2| Beschreibung des Parameters
...
|Parametername n| Beschreibung des Parameters
|return= Beschreibung des Rückgabewertes (falls vorhanden)
}}

---

Überschrift entsprechender Ordnung: Funktionsname

// Header: Name der Headerdatei[en]
Funktionsprototyp

Beschreibung der Funktion

Parameter:

• Parametername 1: Beschreibung des Parameters

• Parametername 2: Beschreibung des Parameters

...

• Parametername n: Beschreibung des Parameters

Rückgabewert: Beschreibung des Rückgabewertes (falls vorhanden)

---