Die JavaScript-Domäne

Hinzugefügt in Version 1.0.

Die JavaScript-Domäne (Name js) stellt die folgenden Direktiven zur Verfügung

.. js:module:: name

Diese Direktive legt den Modulnamen für nachfolgende Objektdeklarationen fest. Der Modulname wird im globalen Modulindex und in Querverweisen verwendet. Diese Direktive erstellt keine Objektüberschrift, wie z. B. die Direktive py:class.

Standardmäßig erstellt diese Direktive eine verlinkbare Entität und erzeugt einen Eintrag im globalen Modulindex, es sei denn, die Option no-index wird angegeben. Wenn diese Option angegeben wird, aktualisiert die Direktive nur den aktuellen Modulnamen.

Hinzugefügt in Version 1.6.

Geändert in Version 5.2: Modul-Direktiven unterstützen Inhaltskörper.

.. js:function:: name(signatur)

Beschreibt eine JavaScript-Funktion oder -Methode. Wenn Sie Argumente als optional beschreiben möchten, verwenden Sie eckige Klammern, wie für Python-Signaturen dokumentiert.

Sie können Felder verwenden, um weitere Details zu Argumenten, deren erwarteten Typen, möglichen Fehlern, die von der Funktion ausgelöst werden können, und dem zurückgegebenen Wert anzugeben.

.. js:function:: $.getJSON(href, callback[, errback])

   :param string href: An URI to the location of the resource.
   :param callback: Gets called with the object.
   :param errback:
       Gets called in case the request fails. And a lot of other
       text so we need multiple lines.
   :throws SomeError: For whatever reason in that case.
   :returns: Something.

Dies wird gerendert als

$.getJSON(href, callback[, errback])
Argumente:

  • href (string) – Eine URI zum Speicherort der Ressource.

  • callback – Wird mit dem Objekt aufgerufen.

  • errback – Wird im Falle eines fehlgeschlagenen Anforderung aufgerufen. Und viele andere Texte, sodass wir mehrere Zeilen benötigen.

Wirft:

SomeError – Aus welchem Grund auch immer in diesem Fall.

Gibt zurück:

Etwas.

:single-line-parameter-list: (kein Wert)

Stellt sicher, dass die Parameter der Funktion in einer einzigen logischen Zeile ausgegeben werden, wobei javascript_maximum_signature_line_length und maximum_signature_line_length überschrieben werden.

Hinzugefügt in Version 7.1.

.. js:method:: name(signatur)

Diese Direktive ist ein Alias für js:function, beschreibt jedoch eine Funktion, die als Methode eines Klassenobjekts implementiert ist.

Hinzugefügt in Version 1.6.

:single-line-parameter-list: (kein Wert)

Stellt sicher, dass die Parameter der Funktion in einer einzigen logischen Zeile ausgegeben werden, wobei javascript_maximum_signature_line_length und maximum_signature_line_length überschrieben werden.

Hinzugefügt in Version 7.1.

.. js:class:: name

Beschreibt einen Konstruktor, der ein Objekt erstellt. Dies ist im Grunde wie eine Funktion, wird aber mit einem class-Präfix angezeigt.

.. js:class:: MyAnimal(name[, age])

   :param string name: The name of the animal
   :param number age: an optional age for the animal

Dies wird gerendert als

class MyAnimal(name[, age])
Argumente:

  • name (string) – Der Name des Tieres

  • age (number) – Ein optionales Alter für das Tier

:single-line-parameter-list: (kein Wert)

Stellt sicher, dass die Parameter der Funktion in einer einzigen logischen Zeile ausgegeben werden, wobei javascript_maximum_signature_line_length und maximum_signature_line_length überschrieben werden.

Hinzugefügt in Version 7.1.

.. js:data:: name

Beschreibt eine globale Variable oder Konstante.

.. js:attribute:: object.name

Beschreibt das Attribut name des object.

Diese Rollen werden bereitgestellt, um auf die beschriebenen Objekte zu verweisen.

:js:mod:
:js:func:
:js:meth:
:js:class:
:js:data:
:js:attr: