1. MDN Web Docs
  2. Schreibrichtlinien
  3. Seitenstrukturen
  4. Seitentypen
  5. Vorlage für JavaScript-Funktionsseiten

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

View in English Always switch to English

Vorlage für JavaScript-Funktionsseiten

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

Front Matter der Seite:

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

md
---
title: nameOfFunction()
slug: Web/JavaScript/Reference/Global_Objects/nameOfFunction
page-type: javascript-function
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: javascript.builtins.nameOfFunction
sidebar: jssidebar
---
title

Überschrift, die oben auf der Seite angezeigt wird. Formatieren Sie sie als nameOfFunction(). Beispielsweise hat die Funktion parseFloat() den title parseFloat().

slug

Das Ende des URL-Pfads nach https://developer.mozilla.org/de/docs/. Dieser sollte wie Web/JavaScript/Reference/Global_Objects/nameOfFunction formatiert sein.

page-type

Der Schlüssel page-type für JavaScript-Funktionen ist javascript-function.

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.nameOfFunction durch die Abfragezeichenfolge für die Funktion 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 zuerst einen Eintrag für die Funktion 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.

Dies ist jssidebar für JavaScript-Funktionsseiten. Einzelheiten finden Sie unter Seitenstrukturen: Sidebars.

Makros am Seitenanfang

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

Diese Makros werden automatisch von der Toolchain hinzugefügt (sie müssen nicht hinzugefügt oder entfernt werden):

  • {{SeeCompatTable}} — dies 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 Präferenz verborgen ist, sollten Sie außerdem einen Eintrag dafür auf der Seite Experimentelle Features in Firefox ausfüllen.
  • {{Non-standard_Header}} — dies erzeugt ein Banner Nicht standardisiert, das darauf hinweist, dass das Feature nicht Teil einer Spezifikation ist.

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

Beispiele für die Banner Experimentell und Nicht standardisiert werden direkt nach diesem Hinweisblock angezeigt.

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

Hinweis: Denken Sie an das wichtigste Prinzip zum Schreiben einheitlicher JavaScript-Referenzseiten: sehen Sie sich um! Viele verwandte Seiten haben einheitliche Strukturen, die über die Anforderungen dieser Vorlage hinausgehen. Beispielsweise alle Proxy-Handler, die meisten Array-Methoden usw. Suchen Sie zunächst nach vorhandener 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 Funktion nameOfFunction() führt etwas aus. Dies sollten idealerweise ein oder zwei kurze Sätze sein. Schreiben Sie im Allgemeinen nicht mehr als einen einzelnen Absatz mit mehr als einigen Sätzen: Wesentliche Details gehören in die Beschreibung.

Schreiben Sie ein interaktives Beispiel, das wichtige Aspekte der Funktion demonstriert.

Probieren Sie es aus

const result = nameOfFunction(1);
console.log(result);
// Expected output: 42

Syntax

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

js
nameOfFunction(parameter1)
nameOfFunction(parameter1, parameter2)

Parameter

parameter1

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

parameter2 Optional

usw.

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

Rückgabewert

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

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

Wenn die Funktion ein Promise zurückgibt, verwenden Sie das Format „Ein Promise, das asynchron mit einer Number erfüllt wird, die etwas darstellt“. 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. Listen Sie im Allgemeinen keine Ausnahmen auf, die durch das Aufrufen von Benutzercode ausgelöst werden können, etwa durch das Ausführen von Gettern oder durch Typumwandlung. Listen Sie keine Ausnahmen aufgrund von Typinkompatibilität 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 größte Teil der Beschreibung der Funktion sollte hier stehen. Seien Sie so umfassend wie möglich. Leser sollten die API anhand dieses Abschnitts vollständig verstehen können, ohne den nachfolgenden Beispielabschnitt lesen zu müssen. Falls Beispiele in diesem Abschnitt erforderlich sind, sollten sie kurz sein und müssen keinen Bezug zur Praxis haben.

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 „Verwenden von nameOfFunction()“ 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 ein, die sich auf die aktuelle Funktion beziehen. 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