Die Dokumentation des globalen Verzeichnisses von JavaScript
Das MDN
Unter Dokumentation verstehen wir hier die Erklärung der Bedeutung von Einträgen eines Verzeichnisses.
Die Dokumentation zu den Einträgen des globalen Verzeichnisses »this« findet sich für JavaScript in Adressen, die mit »http://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference« beginnen (im „MDN“ – “Mozilla Developer Network ”). Auch Namen, die nicht direkt im globalen Verzeichnis, sondern in einem Unterverzeichnis, enthalten sind, werden dokumentiert.
Dort kann auf der Seite „Deutsch“ als Sprache eingestellt werden, um die Inhalte in Deutsch zu lesen.
Die Dokumentation von »Infinity« findet man beispielsweise mit einer Suche nach [Infinity MDN].
Die ECMAScript -Spezifikation
Man kann oft auch die Spezifikation der Sprache ECMAScript heranziehen. So findet man die Dokumentation der mit »this.Math« beginnenden Einträge beispielsweise dort unter „20.2.1 “ (Stand 2015).
Dokumentation eines Eintrags
Die Dokumentation eines Eintrags enthält in der Regel die folgenden Angaben:
- das Verzeichnis des Eintrag (beispielsweise »Math«) oder eine andere Angabe, die besagt, wo dieser Eintrag normalerweise vorkommt,
- den Bezeichnernamen des Eintrags (beispielsweise »PI«),
- den Typ des Eintrags (beispielsweise »number«, auch manchmal in Großschreibung als »Number«),
- eine Erklärung zur Bedeutung des Eintrages,
- den Wert des Eintrag (beispielsweise »3.1415926535897932«), falls für den Eintrag ein fester Wert bekannt ist.
Manchmal finden sich in der Dokumentation zu einem Eintrag darüber hinaus noch weitere Angabe, sie können wir bis auf weiteres ignorieren.
Kontexte und Ziele
In der Dokumentation eines Eintrags soll manchmal auf das Verzeichnis des Eintrags bei seiner Verwendung bezug genommen werden.
Um Verwechslungen mit anderen Verzeichnissen zu vermeiden bezeichnet man das Verzeichnis des Eintrags auch als „Kontext“ oder „Ziel“. Oder „Kontext-“ oder „Ziel-“ wird als Präfixoid verwendet, wie etwa in „Kontextverzeichnis“ oder „Zielverzeichnis“ (also ein Verzeichnis, das als Kontext beziehungsweise Ziel verwendet wird).
Im Ausdruck »Math.PI« ist »Math« der „Kontext“, das „Ziel“, „Zielverzeichnis“ oder „Kontextverzeichnis“ von »PI«.
Dokumentation von Browser-JavaScript
Die Spezifikation von ECMAScript enthält vornehmlich die Dokumentation von Einträge, die unter jeder aktuellen ECMAScript -Implementation vorhanden sein sollten. Darüber hinaus enthält die JavaScript -Implementation in Firefox aber auch noch viele Einträge, die nur in einem Browser oder sogar nur unter Firefox vorhanden sind. Die Dokumentation solcher Einträge, die nicht in der ECMAScript -Spezifikation beschrieben sind, ist nicht das Thema dieser Lektion.