API リファレンスの書き方

このガイドでは、 MDN で API リファレンスを書くために必要なすべてのことを説明します。

準備

API の記事を書き始める前に、実際に書き始める前に準備・計画しておくべきことがいくつかあります。

前提知識

このガイドを読む前に、相応の知識を持っていることを前提としています。

  • HTML、CSS、JavaScript などのウェブ技術。特に JavaScript は重要です。
  • ウェブ技術の仕様書の読み方。 API を文書化する際に、これらの仕様書をよく見ることになるでしょう。

それ以外のことは、その過程で学ぶことができます。

前提条件となるリソース

API の文書化を始める前に、利用可能なものを用意しておく必要があります。

  1. 最新の仕様書: W3C 勧告であれ、初期の編集者草案であれ、その機能をカバーする(またはカバーすることを指定する)仕様書の利用可能な最新の草案を参照する必要があります。それを見つけるには、通常、ウェブ検索を行います。最新版は、多くの場合、その仕様書のすべての版からリンクされており、 "latest draft" などとリストアップされているはずです。
  2. 最新のウェブブラウザー: これらは、 Firefox Nightly/Chrome Canary などの実験的/アルファビルドであるべきで、文書化しようとしている機能に対応している可能性がより高いものです。 これは、特に新しい/実験的な機能を文書化する場合に適切です。
  3. デモ/ブログ記事/その他の情報: できるだけ多くの情報を見つけてください。
  4. 有用な技術連絡先: 仕様について質問できる親切な技術者、 API の標準化やブラウザーへの実装に携わっている人を見つけると本当に有益です。 そのような人を探すのに良い場所には下記のものがあります。
    • あなたが関連企業に勤めている場合、社内アドレス帳。
    • その API の議論に関与している公開メーリングリスト。例えば Mozilla の dev-platform リストや W3C の public-webapps リストなど。
    • 仕様書そのもの。例えば、 Web Audio API 仕様書には、冒頭に作者とその連絡先が記載されています。

時間をかけて API を使ってみる

API を文書化する過程で、何度もデモを作ることになるでしょう。しかし、 API がどのように動作するかに慣れることから始めるのが有効です。主なインターフェイス、プロパティ、メソッドは何か、主な用途は何か、そしてそれを使って簡単な機能を書く方法を学びましょう。

API が変更された場合、参考にしたり学んだりする既存のデモが古くなっていないか注意する必要があります。デモで使われている主な構成要素が、最新の仕様と一致しているかどうかを確認してください。また、最新のブラウザーでは動作しないかもしれませんが、後方互換性のために古い機能に対応し続けていることが多いので、これはあまり信頼できるテストではありません。

Note: 最近仕様が更新され。例えばあるメソッドの定義が変わったが、古いメソッドがまだブラウザーで動作する場合、古いメソッドと新しいメソッドをカバーするために、同じ場所で両方の記事を作成しなければならないことがよくあります。 困ったときは、見つけたデモを参考にしたり、担当のエンジニアに聞いたりしてください。

執筆や更新が必要な記事のリストを作成する

API リファレンスには、一般的に次のようなページが含まれます。 各ページの内容。例、テンプレートの詳細は、ページの種類の記事で確認することができます。 作業を始める前に、作成すべきすべてのページのリストを書き出してください。

  1. 概要ページ
  2. インターフェイスページ
  3. コンストラクターページ
  4. メソッドページ
  5. プロパティページ
  6. イベントページ
  7. 概念/ガイドページ

Note: この記事では。例としてウェブ音声 APIを参照します。

概要ページ

API の概要ページは、 API の役割、最上位のインターフェイス、他のインターフェイスに含まれる関連機能、その他の高水準な詳細を説明するために使われます。 名前とスラッグは API の名前と最後に "API" を付けたものとしてください。 API リファレンスの最上位に置かれ、https://developer.mozilla.org/ja/docs/Web/APIの子として扱われます。

例:

インターフェイスページ

各インターフェイスは、インターフェイスの目的を説明し、メンバー(コンストラクター、メソッド、プロパティなど)をリストアップし、どのブラウザーと互換性があるかを示す、独自のページがあります。 ページの名前とスラッグは、仕様書に書かれているとおりのインターフェイスの名前でなければなりません。 各ページは、 API リファレンスの最上位に、 https://developer.mozilla.org/ja/docs/Web/API の子として配置されます。

例:

Note: インターフェイスに登場するメンバーはすべて文書化します。以下のルールに留意してください。

  • このインターフェイスを実装したオブジェクトのプロトタイプ上で定義されているメソッド(インスタンスメソッド)と、実際のクラス自身で定義されるメソッド(静的メソッド)を文書化します。

まれに同じインターフェイスに両方が存在する場合は、ページ内で別々の節に(静的メソッド/インスタンスメソッドとして)記載します。 通常はインスタンスメソッドしか存在しないので、その場合は「メソッド」というタイトルで記載します。

  • 継承されたプロパティやメソッドは、それぞれの親インターフェイスに掲載されているので文書化しません。しかし、その存在を示唆することはあります。
  • ミックスインで定義されたプロパティやメソッドの記事を作成します。詳しくはミックスインの協力ガイドを参照してください。
  • 文字列化 (toString()) や JSON 化 (toJSON()) のような特殊なメソッドも、存在する場合は掲載します。
  • 名前の付いたコンストラクター(HTMLImageElement における Image() など)も、関連があれば掲載します。

コンストラクターページ

各インターフェイスには 0 個または 1 個のコンストラクターがあり、インターフェイスのページのサブページで文書化されています。コンストラクターの目的を説明し、その構文がどのようなものか、使用例、ブラウザーの互換性情報などを表示します。スラッグはコンストラクターの名前で、インターフェイス名と全く同じです。タイトルはインターフェイス名、ドット、コンストラクター名、そして最後に括弧を置きます。

例:

プロパティページ

各インターフェイスには 0 個以上のプロパティがあり、インターフェイスのページのサブページで説明されています。各ページでは、そのプロパティの目的、構文の様子、使用例、ブラウザーの互換性情報などが説明されています。スラッグはプロパティの名前であり、タイトルはインターフェイス名、ドット、プロパティ名の順になります。

例:

メソッドページ

各インターフェイスには 0 個以上のメソッドがあり、インターフェイスのページのサブページで文書化されています。各ページでは、メソッドの目的を説明し、その構文がどのようなものか、使用例、ブラウザーの互換性情報などを示しています。スラッグはメソッドの名前であり、タイトルはインターフェイス名、ドット、メソッド名、括弧の順です。

例:

イベントページ

イベントはターゲットのインターフェイスのサブページとして文書化し、スラッグは イベント名_event、タイトルは インターフェイス: eventName イベント としてください。

on イベントハンドラープロパティのページを作成しないでください。 eventName_イベント のページで、イベントにアクセスする両方の方法について説明してください。

例:

概念/ガイドページ

ほとんどの API リファレンスには少なくとも 1 つのガイドがあり、時にはそれに付随する概念ページもあります。最低でも API リファレンスには「API 名 の使用」というガイドがあるべきで、これは API の使い方の基本的なガイドを提供するものです。より複雑な API では、 API の異なる側面の使い方を説明するために、複数の使用法ガイドが必要になるかもしれません。

必要であれば、「API 名 の概念」という概念記事も含めることができます。この記事では、 API を効果的に使うために開発者が理解しておくべき、 API に関連する概念の背後にある理論を説明します。

これらの記事はすべて、 API 概要ページのサブページとして作成する必要があります。例えば、ウェブ音声には 4 つのガイドと 1 つの概念の記事があります。

少なくとも、 API の最も一般的な使用例を示すいくつかの例を作成する必要があります。これらは適切な場所に置くことができますが、推奨される場所は MDN の GitHub リポジトリーです。

全体の一覧の作成

これらのサブページの一覧を作成すると、追跡するために便利です。例えば次のようにします。

  • Web_Audio_API
  • AudioContext
    • AudioContext.currentTime
    • AudioContext.destination
    • AudioContext.listener
    • AudioContext.createBuffer()
    • AudioContext.createBufferSource()
  • AudioNode
    • AudioNode.context
    • AudioNode.numberOfInputs
    • AudioNode.numberOfOutputs
    • AudioNode.connect(Param)
  • AudioParam
  • Events (update list)
    • start
    • end

リストの各インターフェイスは、 https://developer.mozilla.org/ja/docs/Web/API のサブページとして独立したページが作成されています。例えば、 AudioContext の記事は、https://developer.mozilla.org/ja/docs/Web/API/AudioContext の場所にあります。各インターフェイスページでは、そのインターフェイスが何をするのかを説明し、そのインターフェイスを構成するメソッドとプロパティのリストを提供しています。そして、各メソッドとプロパティは、それがメンバーであるインターフェイスのサブページとして作成され、それ自身のページで文書化されます。例えば、 BaseAudioContext/currentTime は、 https://developer.mozilla.org/ja/docs/Web/API/AudioContext/currentTime で文書化されています。

ページの作成

次に、以下の構造に従って必要なページを作成します。 MDN の content の README には、新しい記事を作成する手順が書かれています。また、ページの種類のガイドには、役に立つかもしれない例やページテンプレートが書かれています。

概要ページの構成

API ランディングページは、 API の規模によって長さが大きく異なりますが、基本的にはどれも同じような機能を備えています。長いランディングページの例としては https://developer.mozilla.org/ja/docs/Web/API/Web_Audio_API を参照してください。

ランディングページの特徴は、以下の通りです。

  1. 説明: ランディングページの最初の段落では、 API の包括的な目的を短く簡潔に説明する必要があります。
  2. 概要と用途の節: 次の節は、 "[name of API] concepts and usage" と題し、 API が提供する主な機能、解決する問題、動作方法などの概要を、高い水準で説明する必要があります。この節はかなり短くし、コードや特定の実装の詳細には触れないようにしてください。
  3. インターフェイスの一覧: この節は、「[API 名] のインターフェイス」というタイトルで、 API を構成する各インターフェイスのリファレンスページへのリンクと、各インターフェイスの機能についての簡単な説明を提供します。新しいページを素早く作成する方法については、「{{domxref}} マクロを使用した他の API 機能の参照」を参照してください。
  4. : この節では、 API の簡単な使用例を 1 つか 2 つ示してください。
  5. 仕様書一覧表: ここに、仕様書の一覧表を入れる必要があります。詳しくは「仕様書参照表の作成」の節をご覧ください。
  6. ブラウザーの互換性: ここに、ブラウザーの互換性一覧表を入れてください。詳しくは互換性一覧表をご覧ください。
  7. 関連情報: 「関連情報」の節には、 MDN (および外部)のチュートリアル、サンプル、ライブラリーなど、この技術について学ぶ際に役立つかもしれないさらなるリンクを含める野に良い場所です。
  8. タグ: 各リファレンスページに含めるべき標準タグがあります。詳しくは「タグ」の節をご覧ください。

インターフェイスページの構成

これで、インターフェイスのページを書き始める準備が整ったはずです。各インターフェイスリファレンスページは、以下の構造を守る必要があります。

  1. {{APIRef}}: 各インターフェイスページの最初の行に {{APIRef}} マクロを置き、引数に API の名前を入れてください。例えば {{APIRef("Web Audio API")}} のようにします。このマクロは、インターフェイスページの左側にリファレンスメニューを作成します。このマクロはインターフェイスページの左側のリファレンスメニューを構築します。そこにはプロパティやメソッド、および GroupData マクロで定義されたその他のクイックリンクを含みます(既存の GroupData 項目に API を追加するか、まだリストにない場合は新しい項目を作成するよう誰かに依頼してください)。メニューは、以下のスクリーンショットのようなものになります。 このスクリーンショットは、 APIRef マクロによって生成された、メソッドとプロパティの複数のサブリストを持つ OscillatorNode インターフェイスの垂直ナビゲーションメニューを示します。
  2. 標準化の状況: 次に標準化の状況を示すバナーを追加します(これらは、 {{APIRef}} マクロと同じ行に配置することができます)。
    • {{SeeCompatTable}} は実験的な機能の場合(つまり、仕様が勧告候補レベルでない場合)。
    • {{Deprecated_header}}
    • {{Non-standard_header}}
  3. 説明: インターフェイスページの最初の段落では、インターフェイスの包括的な目的を簡潔に説明する必要があります。追加の説明が必要な場合は、さらに数段落を含めるとよいでしょう。インターフェイスが実質的には辞書である場合、「インターフェイス」の代わりにその用語を使用する必要があります。
  4. 継承図: {{InheritanceDiagram}} マクロを使用して、このインターフェイスの SVG の継承図を埋め込みます。
  5. プロパティの一覧、メソッドの一覧: これらの節は、「プロパティ」と「メソッド」というタイトルで、そのインターフェイスのそれぞれのプロパティ/メソッドのリファレンスページへのリンクと({{domxref}} マクロを使用します)、それぞれのプロパティが何を行うかの説明を提供します。これらは説明/定義リストを使用してマークアップしてください。それぞれの説明は短く簡潔にしてください。可能であれば 1 文で。他のページへのリンクを素早く作成する方法については、「{{domxref}} マクロによる他の API 機能の参照」を参照してください。 それぞれの節の冒頭で、プロパティ/メソッドの一覧の前に、イタリック体で適切な文章を使用して継承を示してください。
    • このインターフェイスは固有のプロパティを実装していませんが、 {{domxref("XYZ")}}, および {{domxref("XYZ2")}} からプロパティを継承しています。
    • このインターフェイスには {{domxref("XYZ")}}, および {{domxref("XYZ2")}} から継承したプロパティもあります。
    • このインターフェイスは固有のメソッドを実装していませんが、 {{domxref("XYZ")}}, および {{domxref("XYZ2")}} からメソッドを継承しています。
    • このインターフェイスには {{domxref("XYZ")}}, および {{domxref("XYZ2")}} から継承したプロパティもあります。

    Note: 読み取り専用のプロパティには {{readonlyInline}} マクロを、その {{domxref}} リンクと同じ行に設置すると、小さくてかっこいい「読み取り専用」バッジを生成します。(必要に応じて、{{experimentalInline}}, {{non-standard_Inline}}, {{deprecatedInline}} マクロの後に使用してください)。

  6. : API の主要な機能の典型的な使用法を示すコードリストを入れてください。すべてのコードを列挙するのではなく、そのうちの興味深い部分のみを並べてください。完全なコードのリストを紹介する場合は。例の全体を含んだ GitHub リポジトリーを参照することができます。また、 GitHub gh-pages の機能を使って作成したライブサンプルにリンクすることもできます(もちろん、クライアント側のコードしか使用していなければですが)。サンプルが視覚的であれば、MDN ライブサンプル 機能を使ってページ内でライブ実行できるようにすることができます。
  7. 仕様書一覧表: ここに、仕様書一覧表を入れる必要があります。詳しくは「仕様書参照表の作成」の節をご覧ください。
  8. ブラウザーの互換性: ここで、ブラウザーの互換性一覧表を入れる必要があります。詳しくは、互換性一覧表を参照してください。
  9. ポリフィル: 適切であれば、この節に、 API を実装していないブラウザーでも使用できるようにするためのポリフィルのコードを提供してください。ポリフィルが存在しない、あるいは必要ない場合は、この節は完全に除外してください。
  10. 関連情報: 「関連情報」の節は、 MDN (および外部)のチュートリアル、サンプル、ライブラリーなど、この技術について学ぶときに役立つかもしれないさらなるリンクを置くのに良い場所です。私たちは外部ソースへのリンクに対して自由なポリシーを持っていますが、注意してください。
    • MDN の他のページと同じ情報を持つページを加えないでください。代わりにそのページにリンクしてください。
    • 著者名を記載しないでください - 私たちは作家中立のドキュメントサイトです。ドキュメントにリンクすれば、そこに著者名が表示されます。
    • ブログの記事は特に注意が必要です。古くなりがちだからですです(古い構文、間違った互換性情報)。メンテナンスされた文書にはない明確な付加価値がある場合のみ、リンクを張ってください。
    • 「詳しくは ... を参照してください」や「... をクリックしてください」のような動作動詞は使わないでください。読者が見ることができるかどうか、リンクをクリックできるかどうか(紙版のドキュメントのように)分からないからです。
  11. タグ: 各リファレンスページに設定すべき標準タグがあります。詳しくは「タグ」の節をご覧ください。

インターフェイスのページの例

インターフェイスページの代表的な例を以下に示します。

プロパティページの構成

プロパティページは、それらが実装されているインターフェイスのサブページとして作成してください。他のプロパティページの構造をコピーして、新しいページの基礎とします。

プロパティページの名前は インターフェイス.プロパティ名 という規則に従うように編集してください。

プロパティページには以下の節が必要です。

  1. タイトル: ページのタイトルは、インターフェイス名.プロパティ名 とする必要があります。インターフェイス名は大文字で始めなければなりません。 JavaScript ではインターフェイスはオブジェクトのプロトタイプに実装されますが、 JavaScript リファレンスのようにタイトルに .prototype. を含めることはありません。
  2. {{APIRef}}: 各プロパティページの最初の行に {{APIRef}} マクロを置き、引数に API の名前を入れてください。例えば {{APIRef("Web Audio API")}} のようにします。このマクロは、プロパティページの左側にリファレンスメニューを作成します。このマクロはプロパティページの左側のリファレンスメニューを構築します。そこにはプロパティやメソッド、および GroupData マクロで定義されたその他のクイックリンクを含みます(既存の GroupData 項目に API を追加するか、まだリストにない場合は新しい項目を作成するよう誰かに依頼してください)。メニューは、以下のスクリーンショットのようなものになります。 このスクリーンショットは、 APIRef マクロによって生成された、メソッドとプロパティの複数のサブリストを持つ OscillatorNode インターフェイスの垂直ナビゲーションメニューを示します。
  3. 標準化の状況: 次に標準化の状況を示すバナーを追加します(これらは、 {{APIRef}} マクロと同じ行に配置することができます)。
    • {{SeeCompatTable}} は実験的な機能の場合(つまり、仕様が勧告候補レベルでない場合)。
    • {{Deprecated_header}}
    • {{Non-standard_header}}
  4. 説明: プロパティページの最初の段落には、そのプロパティの包括的な目的を短く簡潔に説明する必要があります。また、追加の説明が必要な場合は、さらにいくつかの段落を書くととよいでしょう。明らかに記述すべき追加情報は、その既定値/初期値、および読み取り専用かどうかです。最初の文の構成は、次のようにしなければなりません。
    読み取り専用のプロパティの場合

    インターフェイス名.プロパティ は読み取り専用のプロパティで、 {{domxref("type")}} を返します…

    その他のプロパティの場合

    インターフェイス名.プロパティ プロパティは {{domxref("type")}} 型で…

    Note: インターフェイス名.プロパティ<code> の中に入れ、最初に使用される場合は太字 (<strong>) で記述してください。

  5. : 値の節では、プロパティの値の説明を行います。これにはプロパティのデータ型と、それが何を表しているかを説明する必要があります。例として、 SpeechRecognition.grammars を参照してください。
  6. : プロパティの典型的な使用方法を示すために、コードのリストを含めてください。その型のオブジェクトがどのように作成され、どのようにプロパティにアクセスするかを示す簡単な例から始める必要があります。より複雑な例は、そのような例の後に追加することができます。すべてのコードを列挙するのではなく、そのうちの興味深い部分のみを並べてください。完全なコードのリストを紹介する場合は。例の全体を含んだ GitHub リポジトリーを参照することができます。また、 GitHub gh-pages の機能を使って作成したライブサンプルにリンクすることもできます(もちろん、クライアント側のコードしか使用していなければですが)。サンプルが視覚的であれば、MDN ライブサンプル 機能を使ってページ内でライブ実行できるようにすることができます。
  7. 仕様書一覧表: ここに、仕様書一覧表を入れる必要があります。詳しくは「仕様書参照表の作成」の節をご覧ください。
  8. ブラウザーの互換性: ここで、ブラウザーの互換性一覧表を入れる必要があります。詳しくは、互換性一覧表を参照してください。
  9. 関連情報: 「関連情報」の節は、この技術を使用する際に役立つかもしれないさらなるリンクを置くのに良い場所です。このプロパティの変更によって影響を受けるメソッドやプロパティ、またはそれに関連して発行されるイベントなどです。 MDN (および外部)のチュートリアル、サンプル、ライブラリーなど、この技術について学ぶ際に役立つリンクを追加することができますが、代わりにインターフェイスのリファレンスページに追加することを考慮すると便利かもしれません。
  10. Tags: 各プロパティページに設定すべき標準タグがあります。詳しくは「タグ」の節をご覧ください。

プロパティページの例

以下に、プロパティページの例を示します。

メソッドページの構成

メソッドページは、実装されるインターフェイスのサブページとして作成してくあさい。他のメソッドページの構造をコピーして、新しいページの基礎とします。

メソッドページには以下の節が必要です。

  1. タイトル: ページのタイトルは、インターフェイス名.メソッド名() (最後に 2 つの括弧つき)とする必要がありますが、スラッグ(ページ URL の最後)は括弧をつけてはいけません。また、インターフェイス名は大文字で始めなければなりません。 JavaScript ではインターフェイスはオブジェクトのプロトタイプに実装されますが、 JavaScript リファレンスのようにタイトルに .prototype. を含めることはありません。
  2. {{APIRef}}: 各メソッドページの最初の行に {{APIRef}} マクロを置き、引数に API の名前を入れてください。例えば {{APIRef("Web Audio API")}} のようにします。このマクロは、メソッドページの左側にリファレンスメニューを作成します。このマクロはインターフェイスページの左側のリファレンスメニューを構築します。そこにはプロパティやメソッド、および GroupData マクロで定義されたその他のクイックリンクを含みます(既存の GroupData 項目に API を追加するか、まだリストにない場合は新しい項目を作成するよう誰かに依頼してください)。メニューは、以下のスクリーンショットのようなものになります。 このスクリーンショットは、 APIRef マクロによって生成された、メソッドとプロパティの複数のサブリストを持つ OscillatorNode インターフェイスの垂直ナビゲーションメニューを示します。
  3. 標準化の状況: 次に標準化の状況を示すバナーを追加します(これらは、 {{APIRef}} マクロと同じ行に配置することができます)。
    • {{SeeCompatTable}} は実験的な機能の場合(つまり、仕様が勧告候補レベルでない場合)。
    • {{Deprecated_header}}
    • {{Non-standard_header}}
  4. 説明: メソッドページの最初の段落には、そのメソッドの包括的な目的を短く簡潔に説明する必要があります。また、追加の説明が必要な場合は、さらにいくつかの段落を書くととよいでしょう。明らかに追加すべき情報は、デフォルト引数の値、そのメソッドが依存する理論、および引数値が行うことです。
    最初の文の冒頭は、次のような構成にしなければなりません。

    インターフェイス名.メソッド名() メソッドインターフェイスは…

    Note: インターフェイス名.メソッド名()<code> の中に入れ、最初に使用される場合は太字 (<strong>) で記述してください。

  5. 構文: 構文の節には、 2 - 3 行の例(通常はインターフェイスの構築とインターフェイスメソッドの呼び出しのみ)を含める必要があります。
    構文は次の形式にしてください。

    method(param1, param2, …)

    構文の節には、以下の 3 つの項を入れてください(例として、 SubtleCrypto.sign() (en-US) を参照してください)。
    • "引数": これには、メソッドが受け取る様々な引数を命名・記述した定義リスト(または順不同のリスト)を置く必要があります。オプションの引数の場合、引数名の隣に 省略可 マクロを置く必要があります。引数がない場合、この項は省略してください。
    • "返値": これはメソッドが持つ返値を示すもので、 double や論理値のような単純な値でも、別なインターフェイスのオブジェクトのような複雑な値でも構いません。この場合、 {{domxref}} マクロを使って、そのインターフェースをカバーする MDN API ページに(存在すれば)リンクすることができます。 メソッドは何も返さない場合がありますが、その場合、返値は "{{jsxref('undefined')}}" と記述します(レンダリングすると undefined と表示されます)。
    • "例外": これは、そのメソッドを呼び出したときに発生する可能性のあるさまざまな例外と、 その例外を発生させる状況を列挙してください。例外が発生しない場合は、この節は省略してください。
  6. : プロパティの典型的な使用方法を示すために、コードのリストを入れてください。すべてのコードを列挙するのではなく、そのうちの興味深い部分のみを並べてください。完全なコードのリストを紹介する場合は。例の全体を含んだ GitHub リポジトリーを参照することができます。また、 GitHub gh-pages の機能を使って作成したライブサンプルにリンクすることもできます(もちろん、クライアント側のコードしか使用していなければですが)。サンプルが視覚的であれば、MDN ライブサンプル 機能を使ってページ内でライブ実行できるようにすることができます。
  7. 仕様書一覧表: ここに、仕様書一覧表を入れる必要があります。詳しくは「仕様書参照表の作成」の節をご覧ください。
  8. ブラウザーの互換性: ここで、ブラウザーの互換性一覧表を入れる必要があります。詳しくは、互換性一覧表を参照してください。

メソッドページの例

以下に、メソッドページの例を示します。

タグ付け

API リファレンスページには、すべてのページに設定すべきタグがあります。

  • "API"
  • "Reference"
  • API の名前 (例: "Web Audio API")
  • 関連するキーワード (例: "audio")

インターフェイスページには、次のものを追加してください。

  • "Interface"
  • インターフェイスの名前。例: "AudioContext"

メソッドページには、次のものを追加してください。

  • "Method"
  • そのメソッドが関連するインターフェイスの名前。例: "AudioContext"
  • メソッドの名前。例: "createBuffer"

プロパティページには、次のものを追加してください。

  • "Property"
  • そのプロパティが関連するインターフェイスの名前。例: "AudioContext"
  • そのプロパティの名前。例: "currentTime"

いずれの場合も、標準化の状況を示すキーワードも追加してください。

  • Deprecated
  • Non-standard

これらのタグは、アイコン付きの正しいクイックリンクを生成するために使用されます。タグ付けに関する追加情報、およびその他の有用なタグについては、適切にタグづけするにはを参照してください。

サイドバー

API リファレンスページを作成したら、ページを関連付けるために適切なサイドバーを挿入したくなるでしょう。 API リファレンスサイドバーのガイドで、その方法を説明します。