Dokumentation von Funktionen in JavaScript 

Wir haben schon gesehen, daß es zu vordefinierten Einträgen in der Regel Dokumentation gibt.

Dies gilt auch für Einträge, die Funktionen sind.

Die Dokumentation zum Eintrag (zur Funktion) »this.Math.random« finden wir beispielsweise im MDN.

Adresse der Dokumentation zur Funktion »this.Math.random«

developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random

Auszug aus der Dokumentation zur Funktion »this.Math.random« (übersetzt)

Syntax

Math.random()

Die Funktion Math.random() ergibt eine Pseudozufallszahl aus dem Intervall [0, 1), also von 0 (einschließlich) bis 1 (ausschließlich) als Gleitkommazahl, die dann auf das benötigte Intervall skaliert werden kann.

Wir geben im folgenden am Beispiel der Funktion »this.Math.random« Bezeichnungen für die verschiedenen Teile der Dokumentation an.

Die Teile der Dokumentation

Die Dokumentation eine Funktion besteht aus einer Proklamation , welche etwas an den Aufruf erinnert und oft in einer dicktengleichen Schrift (Schreibmaschinenschrift) gedruckt wird. Es handelt sich meist um eine Zeile.

Unter der Proklamation befindet sich die Prosa, welche auf Englisch (oder Deutsch) alles wichtige über die beschriebene Funktion aussagt.

Den Namen, der dokumentiert wird, also beispielsweise »random«, bezeichnen wir auch als das Lemma  der Dokumentation. (Die Angabe unter Einbeziehung der Verzeichnisse, wie in »Math.random« oder »this.Math.random«, nennen wir ein qualifiziertes Lemma.)

ECMAScript 

Die Spezifikation der Programmiersprache ECMAScript  wird ebenfalls oft als JavaScript -Dokumentation verwendet.

ECMAScript 2015, 20.2.2.27 (vereinfacht und übersetzt)

Math.random ( )

Ergibt eine Zahl mit einem positiven Vorzeichen, die gleich 0 oder größer als 0 und kleiner als 1 ist, und welche zufällig oder pseudozufällig mit näherungsweiser Gleichverteilung aus diesem Intervall ausgewähl wird.

Jene ECMAScript -Dokumentation besagt noch, daß die Zahlen auch zufällig sein können (sie müssen nicht pseudozufällig sein). Diese Unterscheidung hier zu diskutieren, ist für uns aber nicht wichtig.

Jene ECMAScript -Dokumentation legt außerdem noch fest, daß die Zahlen in dem Intervall [0, 1) näherungsweise gleichverteilt sind, was bei der MDN -Dokumentation wohl stillschweigend angenommen wurde.

Da der Browser Mozilla Firefox  ein Produkt des Herstellers Mozilla  ist, sollte für dieses Produkt zunächst die Dokumentation des Herstellers gelten, also das MDN. Allerdings wird das MDN  tatsächlich von Freiwilligen geschrieben, die gar nicht unbedingt Mitarbeiter des Herstellers sind. Insofern gibt es gar keine offizielle Dokumentation zu „Mozilla JavaScript “. Der Hersteller bemüht sich aber seine Implementation weitestgehend an die ECMAScript -Spezifikation anzupassen. Daher kann man diese oft als Dokumentation zu „Mozilla JavaScript “ verwenden. Mozilla JavaScript  entspricht der ECMAScript -Spezifikation allerdings nicht immer, besonders bei Neuerungen der ECMAScript -Spezifikation, die manchmal in Konflikt mit älteren Festlegungen von Mozilla JavaScript  stehen oder noch nicht (vollständig) in Mozilla JavaScript  übernommen wurden.

(In jener ECMAScript -Dokumentation wird von einer „Zahl“ und nicht von einer „Gleitkommazahl“ gesprochen, was vielleicht treffender ist, denn weil in JavaScript  alle Zahlen Gleitkommazahlen sind, ist die Unterscheidung zwischen Gleitkommazahlen und anderen Zahlen hinfällig. Die ECMAScript -Dokumentation sieht »0« anscheinend als eine Zahl mit einem positiven Vorzeichen an, während 0 in der Mathematik oft als eine Zahl angesehen wird, die weder positiv noch negativ ist.)

Weitere Adressen in Zusammenhang mit Dokumentation

ECMA-262 ECMAScript® 2016 Language Specification

https://www.ecma-international.org/publications/files/ECMA-ST/Ecma-262.pdf

MDN -Register

developer.mozilla.org/en-US/docs/Web/JavaScript/Index

JavaScript Version Information - MSDN - Microsoft

msdn.microsoft.com/en-us/library/s4esdbwz(v=vs.94).aspx