1. MDN Web Docs
  2. Schreibrichtlinien
  3. Seitenstrukturen
  4. Seitentypen
  5. Seitentemplate für statische JavaScript-Methoden

Dieser Inhalt wurde automatisch aus dem Englischen übersetzt, und kann Fehler enthalten. Erfahre mehr über dieses Experiment.

View in English Always switch to English

Seitentemplate für statische JavaScript-Methoden

Hinweis: Entfernen Sie vor der Veröffentlichung diesen gesamten erläuternden Hinweis

Front Matter der Seite:

Das Front Matter am Anfang der Seite wird verwendet, um „Seitenmetadaten“ zu definieren. Die Werte sollten für die jeweilige Methode entsprechend aktualisiert werden.

md
---
title: Constructor.nameOfTheMethod()
short-title: nameOfTheMethod()
slug: Web/JavaScript/Reference/Global_Objects/Constructor/nameOfTheMethod
page-type: javascript-static-method
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: javascript.builtins.Constructor.nameOfTheMethod
sidebar: jsref
---
title

Überschrift, die oben auf der Seite angezeigt wird. Format: Constructor.nameOfTheMethod(). Beispielsweise hat die Methode from() der Klasse Array den title Array.from().

short-title

Ein kurzer Titel, der in Breadcrumbs und Seitenleisten verwendet wird. Format: nameOfTheMethod(). Beispielsweise hat die Methode from() den short-title from().

slug

Das Ende des URL-Pfads nach https://developer.mozilla.org/de/docs/. Dieser wird wie Web/JavaScript/Reference/Global_Objects/Constructor/nameOfTheMethod formatiert. Beachten Sie, dass der Name der Methode im Slug keine Klammern enthält (er endet auf nameOfTheMethod und nicht auf nameOfTheMethod()).

page-type

Der Schlüssel page-type für statische JavaScript-Methoden ist javascript-static-method.

status

Kennzeichnungen, die den Status dieses Features beschreiben. Ein Array, das eines oder mehrere der folgenden Elemente enthalten kann: experimental, deprecated, non-standard. Dieser Schlüssel sollte nicht manuell gesetzt werden: Er wird automatisch anhand der Werte in den Browser-Kompatibilitätsdaten für das Feature gesetzt. Siehe „Wie Feature-Status hinzugefügt oder aktualisiert werden“.

browser-compat

Ersetzen Sie den Platzhalterwert javascript.builtins.Constructor.nameOfTheMethod durch die Abfragezeichenfolge für die Methode im Browser-compat-data-Repository. Die Toolchain verwendet den Schlüssel automatisch, um die Abschnitte zur Kompatibilität und Spezifikation auszufüllen (und ersetzt dabei die Makros {{Compat}} und {{Specifications}}).

Beachten Sie, dass Sie möglicherweise zunächst einen Eintrag für die Methode in unserem Browser-compat-data-Repository erstellen oder aktualisieren müssen und dass der Eintrag für die API Spezifikationsinformationen enthalten muss. Siehe unseren Leitfaden dazu.

Für Seiten zu statischen JavaScript-Methoden lautet dieser Wert jsref. Einzelheiten finden Sie unter Seitenstrukturen: Seitenleisten.

Makros am Seitenanfang

Am Anfang des Inhaltsabschnitts (direkt unter dem Front Matter der Seite) erscheinen mehrere Makroaufrufe.

Diese Makros werden automatisch von der Toolchain hinzugefügt (Sie müssen sie nicht hinzufügen oder entfernen):

  • {{SeeCompatTable}} — erzeugt ein Banner Dies ist eine experimentelle Technologie, das darauf hinweist, dass die Technologie experimentell ist. Wenn sie experimentell ist und die Technologie in Firefox hinter einer Pref verborgen ist, sollten Sie außerdem einen Eintrag dafür auf der Seite Experimentelle Features in Firefox ausfüllen.
  • {{Non-standard_Header}} — erzeugt ein Banner Nicht standardisiert, das darauf hinweist, dass das Feature nicht Teil einer Spezifikation ist.

Geben Sie Status-Header-Makros nicht manuell an. Informationen zum Hinzufügen dieser Status zur Seite finden Sie im Abschnitt Wie Feature-Status hinzugefügt oder aktualisiert werden.

Beispiele der Banner Experimentell und Nicht standardisiert werden direkt nach diesem Hinweisblock angezeigt.

Denken Sie daran, vor der Veröffentlichung diesen gesamten erläuternden Hinweis zu entfernen.

Hinweis: Denken Sie an das wichtigste Prinzip beim Verfassen konsistenter JavaScript-Referenzseiten: sehen Sie sich um! Viele verwandte Seiten haben über die Anforderungen dieses Templates hinaus konsistente Strukturen. Beispielsweise alle Proxy-Handler, die meisten Array-Methoden usw. Suchen Sie zunächst nach bestehender Dokumentation für ähnliche APIs und übernehmen Sie deren Struktur.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Nicht standardisiert: Diese Funktion ist nicht standardisiert. Wir raten davon ab, nicht-standardisierte Funktionen auf produktiven Webseiten zu verwenden, da sie nur von bestimmten Browsern unterstützt werden und sich in Zukunft ändern oder entfernt werden können. Unter Umständen kann sie jedoch eine geeignete Option sein, wenn es keine standardisierte Alternative gibt.

Die statische Methode Constructor.nameOfTheMethod() führt etwas aus. Dies sollten idealerweise ein oder zwei kurze Sätze sein. Halten Sie dies mit der Einstiegsseite des Konstruktors synchron — beispielsweise sollte die Einstiegsseite Zeilen wie diese enthalten:

md
- {{jsxref("Constructor.nameOfTheMethod()")}}
  - : Does something.

Syntax

Füllen Sie gemäß den Hinweisen in unserem Artikel zu Syntaxabschnitten einen Syntaxkasten aus.

js
Constructor.nameOfTheMethod(parameter1)
Constructor.nameOfTheMethod(parameter1, parameter2)

Parameter

parameter1

Fügen Sie hier eine kurze Beschreibung des Parameters und seiner Funktion ein. Geben Sie für jeden Parameter einen Begriff und eine Definition an. Wenn der Parameter nicht optional ist, entfernen Sie den Makroaufruf {{optional_inline}}.

parameter2 Optional

usw.

Hinweis: Dieser Abschnitt ist obligatorisch. Falls es keine Parameter gibt, schreiben Sie statt der Definitionsliste „Keine“.

Rückgabewert

Fügen Sie eine Beschreibung des Rückgabewerts der Methode ein, einschließlich Datentyp und Bedeutung. Beispiel: „Ein Number, der etwas darstellt.“

Falls die Methode nichts zurückgibt, schreiben Sie einfach „Keine (undefined).“.

Falls die Methode ein Promise zurückgibt, geben Sie an, ob es bereits erfüllt oder asynchron erfüllt wird, sowie den Erfüllungswert. Abgelehnte Promises gehören in den Abschnitt „Ausnahmen“.

Ausnahmen

TypeError

Wird in einem der folgenden Fälle ausgelöst:

  • Bedingung 1.
  • Bedingung 2.
  • usw.
RangeError

Wird ausgelöst, wenn …

Seien Sie so umfassend wie möglich. Im Allgemeinen sollten Sie keine Ausnahmen aufführen, die beim Ausführen von Benutzercode ausgelöst werden können, etwa beim Ausführen von Gettern oder bei der Typumwandlung. Führen Sie keine Ausnahmen aufgrund von Typkonflikten auf, etwa wenn ein Symbol an einen Parameter übergeben wird, der einen String erwartet, oder wenn eine Nicht-Funktion als Callback übergeben wird.

Beschreibung

Der Großteil der Beschreibung der Methode sollte hier stehen. Seien Sie so umfassend wie möglich. Falls viele Seiten dieselbe Beschreibung teilen, ziehen Sie in Betracht, einen neuen Abschnitt auf der Einstiegsseite der Klasse hinzuzufügen und von hier darauf zu verlinken. Beispielsweise wird Array-Methoden und leere Slots von jeder Seite zu Array-Methoden verlinkt.

Leser sollten die API anhand dieses Abschnitts vollständig verstehen können, ohne den unten stehenden Beispielabschnitt zu lesen. Beispiele in diesem Abschnitt sollten, falls erforderlich, kurz sein und müssen nicht praxisrelevant sein.

Beispiele

Beachten Sie, dass wir den Plural „Beispiele“ verwenden, auch wenn die Seite nur ein Beispiel enthält.

Eine beschreibende Überschrift

Jedes Beispiel muss eine H3-Überschrift haben, die das Beispiel benennt. Die Überschrift sollte beschreiben, was das Beispiel tut. Beispielsweise sagt „Ein einfaches Beispiel“ nichts über das Beispiel aus und ist daher keine gute Überschrift. Die Überschrift sollte kurz sein. Verwenden Sie für eine längere Beschreibung den Absatz nach der Überschrift. Das erste Beispiel kann „Verwendung von nameOfTheMethod()“ heißen.

Weitere Informationen finden Sie in unserem Leitfaden zum Hinzufügen von Codebeispielen.

Spezifikationen

{{Specifications}}

Um dieses Makro zu verwenden, entfernen Sie die Backticks und den Backslash in der Markdown-Datei.

Browser-Kompatibilität

{{Compat}}

Um dieses Makro zu verwenden, entfernen Sie die Backticks und den Backslash in der Markdown-Datei.

Siehe auch

Fügen Sie Links zu Referenzseiten und Leitfäden hinzu, die mit der aktuellen Methode zusammenhängen. Weitere Richtlinien finden Sie im Abschnitt Siehe auch im Leitfaden zum Schreibstil.

Help improve MDN

Erfahren Sie, wie Sie beitragen können Diese Seite wurde automatisch aus dem Englischen übersetzt.
Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden