Dokumentation in C 

Die Beschreibung einer Bibliothek (API) oder eines ihrer Teile wird oft als Dokumentation  bezeichnet.

Die vordefinierten Namen von C  gehören zur C -Standardbibliothek.

Die Dokumentation der Standardbibliothek in der Spezifikation von C  beschrieben und findet sich auch in vielen Lehrbüchern, Nachschlagewerken  oder Webseiten  (Stichwörter »N1570«, »C reference«).

5 (2014) http://docwiki.embarcadero.com/RADStudio/XE6/de/Referenz_zur_C-Laufzeitbibliothek_-_Index
4 (2014) http://de.wikibooks.org/wiki/C-Programmierung:_Standard_Header
4 (2014) http://openbook.galileo-press.de/linux_unix_programmierung/Kap18B-000.htm
4 (2014) http://de.wikibooks.org/wiki/C-Programmierung:_Standard_Header
- (2014) C in a Nutshell (deutsche Ausgabe) isbn=3897213443 Peter Prinz, Tony Crawford 2006

Falls jemand auch englische Texte lesen möchte, so ist die Dokumentation der web site  »en.cppreference.com« gut geeignet. Da sie aber auch Seiten zur Programmiersprache C++  umfaßt, sollte man darauf achten, dort die Seiten für C  abzurufen und nicht die manchmal ähnlichen Seiten zu C++.

Die C-Norm enthält eine Dokumentation (Beschreibung) der von der Standardbibliothek definierten Namen.

»errno« [Dokumentation nach N1570 7.5 Errors, vereinfacht]

#include <errno.h>
int errno;
error number
Fehlerkennzahl

(/ˈɛɚɚ ˈnʌmbɚ/)

Wir sehen in der Dokumentation des Bezeichners »errno«:

• die benötigte Direktive,
• den Datentyp des Bezeichners: »int«,
• den Namen des Bezeichners: »errno«,
• ein Semikolon, das diese Zeile der Dokumentation abschließt;
• sowie schließlich eine englischsprachigen Beschreibung der Bedeutung dieses Namens.
• In diesem Kurs geben wir zu englischsprachigen Texten meist auch eine deutsche Übersetzung an.

Zur englischen Sprache

Obwohl die Norm von C  in englisch verfaßt ist, ist es nicht  nötig, Englisch zu lernen, um C  zu erlernen, denn die wichtigsten Informationen aus der C -Norm können auch in deutschsprachigen Nachschlagewerken nachgelesen werden.

Manual Pages

Die klassische Dokumentation von C sind die manual pages, welche aber leider nicht unter allen Implementationen verfügbar sind.

Unter einem Unix-ähnlichen Betriebssystem führt die Eingabe des Kommandos »man errno« beispielsweise zur Ausgabe der manual page  (kurz: “man page ”) für »errno«.

Konsole

$ man errno
ERRNO(3)                   Linux Programmer's Manual                  ERRNO(3)
NAME
       errno - number of last error
SYNOPSIS
       #include <errno.h>
DESCRIPTION
       The  <errno.h> header file defines the integer variable errno, which is
       set by system calls and some library functions in the event of an error
       to  indicate  what  went wrong.  Its value is significant only when the

       ...

Entsprechend der Bezeichnung aus den manual pages  nennen wir hier eine kurze schematische Beschreibung eines Namens, wie etwa unter diesem Absatz für »errno« angegeben, auch eine Synopse.

»errno« [Synopse]

#include <errno.h>
int errno;
error number
Fehlerkennzahl

Der Name »errno« dient hier als Beispiel  für einen Namen. Abgesehen von dieser Funktion als Beispiel ist »errno« selber nicht so wichtig. Man muß es sich also nicht merken!