1. MDN Web Docs
  2. Schreibrichtlinien
  3. Seitenstrukturen
  4. Seitentypen
  5. API-Methode Unterseite Vorlage

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

View in English Always switch to English

API-Methode Unterseite Vorlage

Hinweis: Entfernen Sie diese gesamte erklärende Notiz vor der Veröffentlichung.

Seitenvorderseite:

Die Vorderseite am Anfang der Seite wird verwendet, um "Seitenmetadaten" zu definieren. Die Werte sollten entsprechend für die jeweilige Methode aktualisiert werden.

md
---
title: NameOfTheParentInterface.NameOfTheMethod()
slug: Web/API/NameOfTheParentInterface/NameOfTheMethod
page-type: web-api-instance-method ODER web-api-static-method
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheMethod
---
title

Titelüberschrift, die oben auf der Seite angezeigt wird. Formatieren Sie als "NameOfTheParentInterface: NameOfTheMethod() method". Zum Beispiel hat die count() Methode der IDBIndex Schnittstelle einen title von IDBIndex: count() method.

slug

Das Ende des URL-Pfads nach https://developer.mozilla.org/de/docs/. Dies wird wie Web/API/NameOfTheParentInterface/NameOfTheMethod formatiert.

Wenn die Methode statisch ist, muss der Slug ein _static Suffix haben, wie: Web/API/NameOfTheParentInterface/NameOfTheMethod_static. Dies ermöglicht es uns, Instanz- und statische Methoden mit demselben Namen zu unterstützen.

Beachten Sie, dass der Name der Methode im Slug die Klammern weglässt (er endet in NameOfTheMethod, nicht NameOfTheMethod()).

page-type

Der page-type Schlüssel für Web/API-Methoden ist entweder web-api-instance-method (für Instanzmethoden) oder web-api-static-method (für statische Methoden).

status

Kennzeichen, die den Status dieser Funktion beschreiben. Ein Array, das eines oder mehrere der folgenden enthalten kann: experimental, deprecated, non-standard. Dieser Schlüssel sollte nicht manuell gesetzt werden: Er wird automatisch basierend auf Werten in den Browser-Kompatibilitätsdaten für die Funktion gesetzt. Siehe "Wie Funktionsstatus hinzugefügt oder aktualisiert werden".

browser-compat

Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheMethod mit dem Abfragezeichenkette für die Methode im Browser-compat-Daten-Repository. Die Toolchain verwendet den Schlüssel automatisch, um die Kompatibilitäts- und Spezifikationsabschnitte zu füllen (ersetzen der {{Compat}} und {{Specifications}} Makros).

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für die API-Methode in unserem Browser-compat-Daten-Repository erstellen/aktualisieren müssen, und der Eintrag für die API muss Spezifikationsinformationen enthalten. Siehe unseren Leitfaden, wie man dies tut.

Top-of-page Macros

Eine Reihe von Makroaufrufen erscheint oben im Inhaltsabschnitt (unmittelbar unter der Seitenvorderseite).

Diese Makros werden automatisch von der Toolchain hinzugefügt (es ist nicht nötig, sie hinzuzufügen/zu entfernen):

  • {{SeeCompatTable}} — erzeugt ein Dies ist eine experimentelle Technologie Banner, das anzeigt, dass die Technologie experimentell ist. Wenn sie experimentell ist und die Technologie in Firefox hinter einem Präf versteckt ist, sollten Sie auch einen Eintrag dafür auf der Seite Experimentelle Funktionen in Firefox ausfüllen.
  • {{Deprecated_Header}} — erzeugt ein Veraltet Banner, das anzeigt, dass die Verwendung der Technologie nicht empfohlen wird.
  • {{Non-standard_Header}} — erzeugt ein Nicht-standardmäßiges Banner, das anzeigt, dass die Funktion nicht Teil einer Spezifikation ist.

Sie sollten die folgenden Makros gemäß den untenstehenden Anweisungen aktualisieren oder löschen:

  • {{SecureContext_Header}} — erzeugt ein Sicherer Kontext Banner, das anzeigt, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn nicht, können Sie den Makroaufruf entfernen. Wenn doch, sollten Sie auch einen Eintrag dafür auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind ausfüllen.
  • {{AvailableInWorkers}} — erzeugt eine Verfügbar in Arbeiter Notiz, die anzeigt, dass die Technologie im Arbeiterkontext verfügbar ist. Wenn sie nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn sie auch oder nur im Arbeiterkontext verfügbar ist, müssen Sie möglicherweise einen Parameter hinzufügen, um die Verfügbarkeit festzulegen (siehe {{AvailableInWorkers}} Makro-Quellcode für alle verfügbaren Werte), möglicherweise müssen Sie auch einen Eintrag auf der Seite Web APIs available in workers ausfüllen.
  • {{APIRef("GroupDataName")}} — erzeugt die Referenz-Seitenleiste auf der linken Seite, die schnelle Referenzlinks zeigt, die sich auf die aktuelle Seite beziehen. Zum Beispiel hat jede Seite der WebVR API die gleiche Seitenleiste, die auf die anderen Seiten der API verweist. Um die korrekte Seitenleiste für Ihre API zu erstellen, müssen Sie einen GroupData Eintrag in unserem GitHub-Repo hinzufügen und den Namen des Eintrags im Makroaufruf anstelle von GroupDataName einfügen. Siehe unseren API-Referenzseitenleisten Leitfaden für Informationen, wie dies zu tun ist.

Status-Header-Makros sollten nicht manuell bereitgestellt werden. Lesen Sie den Abschnitt "Wie Funktionsstatus hinzugefügt oder aktualisiert werden", um diese Status zur Seite hinzuzufügen.

Beispiele für die Sicherer Kontext, Verfügbar in Arbeiter, Experimentell, Veraltet und Nicht-standardmäßig Banner werden direkt nach diesem Notizblock gezeigt.

Denken Sie daran, diese gesamte erklärende Notiz vor der Veröffentlichung zu entfernen.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

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

Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, könnte sie bereits aus den relevanten Webstandards entfernt worden sein, in Kürze entfernt werden oder nur noch aus Kompatibilitätsgründen bestehen. Vermeiden Sie die Verwendung und aktualisieren Sie vorhandenen Code, falls möglich; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu unterstützen. Beachten Sie, dass diese Funktion jederzeit aufhören könnte zu funktionieren.

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.

Beginnen Sie den Inhalt auf der Seite mit einem einleitenden Absatz — beginnen Sie mit dem Namen der Methode, sagen Sie, zu welcher Schnittstelle sie gehört, und was sie tut. Dies sollte idealerweise aus einem oder zwei kurzen Sätzen bestehen. Sie könnten den größten Teil davon aus der Zusammenfassung der Methode auf der entsprechenden API-Referenzseite kopieren.

Syntax

Füllen Sie ein Syntaxfeld gemäß den Anleitungen in unserem Artikel zu Syntaxabschnitten aus.

Parameter

parameter1 Optional

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

parameter2

usw.

Hinweis: Dieser Abschnitt ist obligatorisch. Wenn es keine Parameter gibt, setzen Sie None. anstelle der Definitionsliste.

Rückgabewert

Fügen Sie eine Beschreibung des Rückgabewerts der Methode ein, einschließlich des Datentyps und was er darstellt.

Wenn die Methode nichts zurückgibt, geben Sie einfach "None (undefined)." ein.

Ausnahmen

Geben Sie eine Liste aller Ausnahmen an, die die Methode auslösen kann. Fügen Sie für jede Ausnahme einen Begriff und eine Definition hinzu.

Exception1

Fügen Sie Beschreibungen hinzu, wie die Ausnahme ausgelöst wird.

Exception2

Fügen Sie Beschreibungen hinzu, wie die Ausnahme ausgelöst wird.

Beachten Sie, dass wir zwei Arten von Ausnahmen haben: DOMException Objekte und reguläre JavaScript-Ausnahmen, wie TypeError und RangeError. Ein Webentwickler muss wissen:

  • welches Objekt geworfen wird
  • für Ausnahmen, die DOMException Objekte sind, der name der Ausnahme.

Hier ist ein Beispiel, bei dem eine Methode eine DOMException mit einem Namen von IndexSizeError, eine zweite DOMException mit einem Namen von InvalidNodeTypeError und eine JavaScript-Ausnahme vom Typ TypeError auslösen kann:

IndexSizeError DOMException

Geworfen …

InvalidNodeTypeError DOMException

Geworfen …

TypeError

Geworfen …

Beschreibung

Detaillierte Beschreibung, wie sich die Methode verhält Abschnitt weggelassen, wenn ein einleitender Absatz (oder zwei) oben auf der Seite ausreichen.

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 mit dem Namen des Beispiels haben. Die Überschrift sollte beschreiben, was das Beispiel tut. Zum Beispiel sagt "Ein einfaches Beispiel" nichts über das Beispiel aus und ist daher keine gute Überschrift. Die Überschrift sollte prägnant sein. Für eine längere Beschreibung verwenden Sie den Absatz nach der Überschrift.

Weitere Informationen finden Sie in unserem Leitfaden, wie Sie Codebeispiele hinzufügen.

Hinweis: Manchmal möchten Sie auf Beispiele auf einer anderen Seite verlinken.

Szenario 1: Wenn Sie einige Beispiele auf dieser Seite und einige weitere Beispiele auf einer anderen Seite haben:

Fügen Sie eine H3-Überschrift (###) für jedes Beispiel auf dieser Seite hinzu und dann eine letzte H3-Überschrift (###) mit dem Text "Weitere Beispiele", unter der Sie auf die Beispiele auf anderen Seiten verlinken können. Zum Beispiel:

md
## Beispiele

### Verwenden der fetch API

Beispiel von Fetch

### Weitere Beispiele

Links zu weiteren Beispielen auf anderen Seiten

Szenario 2: Wenn Sie nur Beispiele auf einer anderen Seite und keine auf dieser Seite haben:

Fügen Sie keine H3-Überschriften hinzu; fügen Sie die Links direkt unter der H2-Überschrift "Beispiele" hinzu. Zum Beispiel:

md
## Beispiele

Für Beispiele zu dieser API siehe [die Seite zu fetch()](https://example.org/).

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 sich auf die aktuelle API beziehen. Für weitere Richtlinien siehe den Siehe auch Abschnitt im Schreibstil-Leitfaden.

  • link1
  • link2
  • extern_link (Jahr)

Help improve MDN

Learn how to contribute Diese Seite wurde automatisch aus dem Englischen übersetzt.
Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden