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

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-Unterseiten-Template

Hinweis: Entfernen Sie diese gesamte erklärende Notiz, bevor Sie die Seite veröffentlichen.

Page Front Matter:

Das Front Matter am Anfang der Seite wird verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten für die jeweilige Methode entsprechend 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

Überschrift, die oben auf der Seite angezeigt wird. Formatieren Sie 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 formatiert als Web/API/NameOfTheParentInterface/NameOfTheMethod.

Wenn die Methode statisch ist, muss der Slug ein _static Suffix haben, z.B.: Web/API/NameOfTheParentInterface/NameOfTheMethod_static. So können wir Instanzmethoden und statische Methoden mit demselben Namen unterstützen.

Beachten Sie, dass der Name der Methode im Slug die Klammern weglässt (er endet mit 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

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 basierend auf den Werten in den Browser-Kompatibilitätsdaten für das Feature automatisch gesetzt. Siehe "Wie Feature-Status hinzugefügt oder aktualisiert werden".

browser-compat

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

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für die API-Methode in unserem Browser compat data repo erstellen/aktualisieren müssen, und der Eintrag für die API wird Spezifikationsinformationen enthalten müssen. Siehe unseren Leitfaden dazu, wie das gemacht wird.

Oben auf der Seite befindliche Makros

Eine Reihe von Makroaufrufen erscheint oben im Inhaltsbereich (unmittelbar unter dem Page Front Matter).

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

  • {{SeeCompatTable}} — dies erzeugt ein Das ist eine experimentelle Technologie-Banner, das anzeigt, dass die Technologie experimentell ist. Wenn es experimentell ist und die Technologie hinter einem Pref in Firefox versteckt ist, sollten Sie auch einen Eintrag dafür auf der Seite Experimentelle Features in Firefox ausfüllen.
  • {{Deprecated_Header}} — dies erzeugt ein Veraltet-Banner, das anzeigt, dass die Verwendung der Technologie nicht empfohlen ist.
  • {{Non-standard_Header}} — dies erzeugt ein Nicht-standardisiert-Banner, das anzeigt, dass das Feature nicht Teil einer Spezifikation ist.

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

  • {{SecureContext_Header}} — dies erzeugt ein Sicherer Kontext-Banner, das anzeigt, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn es das nicht ist, können Sie den Makroaufruf entfernen. Wenn es das ist, sollten Sie auch einen Eintrag dafür auf der Seite Merkmale, die auf sichere Kontexte beschränkt sind ausfüllen.
  • {{AvailableInWorkers}} — dies erzeugt einen Verfügbar in Arbeitern-Hinweis, der anzeigt, dass die Technologie im Arbeiterkontext verfügbar ist. Wenn es nur im Fenst-Kontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn es auch oder nur im Arbeiterkontext verfügbar ist, müssen Sie möglicherweise einen Parameter dazu übergeben, je nach seiner Verfügbarkeit (siehe {{AvailableInWorkers}}-Makro-Quellcode für alle verfügbaren Werte), möglicherweise müssen Sie auch einen Eintrag dafür auf der Seite Web-APIs, die in Arbeitern verfügbar sind ausfüllen.
  • {{APIRef("GroupDataName")}} — dies erzeugt die Referenz-Seitenleiste auf der linken Seite, die Schnellzugriffslinks anzeigt, die mit der aktuellen Seite in Zusammenhang stehen. Zum Beispiel hat jede Seite in der WebVR API dieselbe Seitenleiste, die auf die anderen Seiten in der API verweist. Um die richtige Seitenleiste für Ihre API zu erstellen, müssen Sie einen GroupData-Eintrag in unserem GitHub-Repo hinzufügen und den Namen des Eintrags innerhalb des Makroaufrufs anstelle von GroupDataName angeben. Siehe unser Leitfaden zu API-Referenz-Seitenleisten für weitere Informationen, wie Sie dies tun.

Geben Sie Status-Header-Makros nicht manuell an. Beziehen Sie sich auf den Abschnitt "Wie Feature-Status hinzugefügt oder aktualisiert werden", um diese Status auf der Seite hinzuzufügen.

Beispiele der Sicherer Kontext, Verfügbar in Arbeitern, Experimentell, Veraltet und Nicht-standardisiert 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 Einführungstext — beginnen Sie mit der Benennung der Methode, benennen Sie die Schnittstelle, der sie angehört, und beschreiben Sie, was sie tut. Idealerweise sollte dies ein oder zwei kurze Sätze umfassen. Sie könnten einen Großteil davon aus der Zusammenfassung der Methode auf der entsprechenden API-Referenzseite kopieren.

Syntax

Füllen Sie ein Syntaxfeld aus, gemäß der Richtlinien im Artikel über unsere Syntaxabschnitte.

Parameter

parameter1 Optional

Fügen Sie hier eine kurze Beschreibung des Parameters und dessen Zweck ein. 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ückgabewertes der Methode ein, einschließlich des Datentyps und dessen, was er repräsentiert.

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

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 hinzu.

Exception1

Beschreiben Sie, wie die Ausnahme ausgelöst wird.

Exception2

Beschreiben Sie, 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 Folgendes 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 dem Namen IndexSizeError, eine zweite DOMException mit dem Namen InvalidNodeTypeError und eine JavaScript-Ausnahme vom Typ TypeError werfen kann:

IndexSizeError DOMException

Wird geworfen …

InvalidNodeTypeError DOMException

Wird geworfen …

TypeError

Wird geworfen …

Beschreibung

Detaillierte Beschreibung, wie sich die Methode verhält Abschnitt weggelassen, wenn ein einführender Absatz (oder zwei) am Anfang der Seite ausreichend ist.

Beispiele

Beachten Sie, dass wir den Plural "Beispiele" verwenden, selbst 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. 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 zum Hinzufügen von Code-Beispielen.

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

### Nutzung 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 einfach direkt unter der H2-Überschrift "Beispiele" hinzu. Zum Beispiel:

md
## Beispiele

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

Spezifikationen

{{Specifications}}

Um dieses Makro zu verwenden, entfernen Sie die Rückwärtsschritte und den Rückschrägstrich in der Markdown-Datei.

Browser-Kompatibilität

{{Compat}}

Um dieses Makro zu verwenden, entfernen Sie die Rückwärtsschritte und den Rückschrägstrich in der Markdown-Datei.

Siehe auch

Fügen Sie Links zu Referenzseiten und Leitfäden hinzu, die mit der aktuellen API in Zusammenhang stehen. Für weitere Richtlinien sehen Sie den Abschnitt "Siehe auch" im Schreibstil-Leitfaden.

  • link1
  • link2
  • external_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