1. MDN Web Docs
  2. Schreibrichtlinien
  3. Seitenstrukturen
  4. Seitentypen
  5. API-Methoden-Unterseitenvorlage

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-Methoden-Unterseitenvorlage

Hinweis: Entfernen Sie diese gesamte Erläuterungsnotiz vor der Veröffentlichung.

Seiten-Metadaten:

Die Metadaten am Anfang der Seite werden verwendet, um "Seitenmetadaten" zu definieren. Die Werte sollten entsprechend der jeweiligen Methode aktualisiert werden.

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

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

slug

Der Endteil 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 mit NameOfTheMethod und 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

Kennzeichnungen, die den Status dieses Features beschreiben. Ein Array, das einen oder mehrere der folgenden Werte enthalten kann: experimental, deprecated, non-standard. Dieser Schlüssel sollte nicht manuell gesetzt werden: Er wird automatisch basierend auf Werten in den Daten zur Browser-Kompatibilität für das Feature gesetzt. Siehe "Wie Feature-Statuse hinzugefügt oder aktualisiert werden".

browser-compat

Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheMethod durch die Abfragezeichenfolge für die Methode im Browser-Kompatibilitätsdaten-Repository. Die Toolchain verwendet den Schlüssel automatisch, um die Kompatibilitäts- und Spezifikationsabschnitte auszufüllen (ersetzt die {{Compat}} und {{Specifications}} Makros).

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für die API-Methode in unserem Browser-Kompatibilitätsdaten-Repository erstellen/aktualisieren müssen, und der Eintrag für die API muss Spezifikationsinformationen enthalten. Siehe unseren Leitfaden, wie das geht.

Makros am Anfang der Seite

Eine Reihe von Makroaufrufen erscheint am Anfang des Inhaltsabschnitts (unmittelbar unter den Seitenmetadaten).

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

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

Sie sollten die folgenden Makros entsprechend den unten stehenden Ratschlägen aktualisieren oder löschen:

  • {{SecureContext_Header}} — erzeugt ein Sicherer Kontext-Banner, das darauf hinweist, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn dies nicht der Fall ist, können Sie den Makroaufruf entfernen. Wenn doch, sollten Sie auch einen Eintrag dafür auf der Seite Features, die auf sichere Kontexte beschränkt sind ausfüllen.
  • {{AvailableInWorkers}} — erzeugt eine Verfügbar in Workers-Notiz, die darauf hinweist, dass die Technologie im Worker-Kontext verfügbar ist. Wenn sie nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn sie auch im Worker-Kontext verfügbar oder nur dort verfügbar ist, müssen Sie möglicherweise einen Parameter aufgrund ihrer Verfügbarkeit übergeben (sehen Sie sich den Source code der {{AvailableInWorkers}}-Makros für alle verfügbaren Werte an), und Sie müssen möglicherweise auch einen Eintrag dafür auf der Seite Web-APIs, die in Workers verfügbar sind ausfüllen.
  • {{APIRef("GroupDataName")}} — erzeugt die linksseitige Referenz-Sidebar, die Schnellreferenz-Links zeigt, die sich auf die aktuelle Seite beziehen. Zum Beispiel hat jede Seite der WebVR API dieselbe Sidebar, die auf die anderen Seiten der API verweist. Um die korrekte Sidebar für Ihre API zu generieren, müssen Sie einen GroupData-Eintrag in unserem GitHub-Repository hinzufügen und den Namen des Eintrags im Makroaufruf anstelle von GroupDataName angeben. Siehe unseren Leitfaden zum Schreiben von API-Referenzseiten-Sidebars für Informationen darüber, wie man das macht.

Liefern Sie keine Statusheader-Makros manuell. Informationen darüber, wie diese Status zu der Seite hinzugefügt werden, finden Sie im Abschnitt "Wie Fature-Statuse hinzugefügt oder aktualisiert werden".

Beispiele für Sicherer Kontext, Verfügbar in Workern, Experimentell, Veraltet und Nicht-standardized-Banner werden gleich nach diesem Notizblock angezeigt.

Denken Sie daran, diese gesamte Erläuterungsnotiz 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.

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 der Seite mit einem einleitenden Absatz — beginnen Sie damit, die Methode zu benennen, zu sagen, zu welcher Schnittstelle sie gehört, und zu erklären, was sie tut. Dies sollte idealerweise ein oder zwei kurze Sätze sein. Sie könnten den Großteil davon aus der Zusammenfassung der Methode auf der entsprechenden API-Referenzseite übernehmen.

Syntax

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

Parameter

parameter1 Optional

Fügen Sie eine kurze Beschreibung des Parameters und dessen Funktion hier ein. Fügen Sie für jeden Parameter einen Begriff und eine Definition ein. 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

Schließen Sie eine Beschreibung des Rückgabewerts der Methode ein, einschließlich des Datentyps und dessen Bedeutung.

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

Ausnahmen

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

Exception1

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

Exception2

usw.

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 IndexSizeError auslösen kann, eine zweite DOMException mit einem Namen InvalidNodeTypeError und eine JavaScript-Ausnahme vom Typ TypeError:

IndexSizeError DOMException

Ausgelöst …

InvalidNodeTypeError DOMException

Ausgelöst …

TypeError

Ausgelöst …

Beschreibung

Detaillierte Beschreibung, wie die Methode funktioniert Abschnitt weglassen, wenn ein einleitender Absatz (oder zwei) oben auf der Seite ausreichend sind.

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 nennt. Die Überschrift sollte beschreiben, was das Beispiel macht. 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.

Sehen Sie sich unseren Leitfaden an, wie man Codebeispiele hinzufügt für weitere Informationen.

Hinweis: Manchmal möchten Sie auf Beispiele verlinken, die auf einer anderen Seite gegeben sind.

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

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

md
## Beispiele

### Verwendung der Fetch-API

Beispiel für 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 dieser API, sehen Sie [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 mit der aktuellen API zusammenhängen. Für weitere Richtlinien, siehe den Abschnitt Siehe auch im Schreibstil-Leitfaden.

  • link1
  • link2
  • external_link (Jahr)

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