ウェブのエラーを文書化する方法
MDN JavaScript error reference は Developer Console で発生するエラーについて、ウェブ開発者を手助けすることを目的とした新しいプロジェクトです。
この機能は、Firefox (Developer Edition) をお使いの場合に有効です。JavaScript エラーに含まれる "Learn more" が問題の修正に役立つ追加のアドバイスを含む JavaScript error reference にリンクしています。
このプロジェクトを助けるには、メッセージが投げられるツールからより多くのリンクを追加できるように、もっと多くの MDN エラードキュメントを書くことが必要です。
前提条件
- MDN アカウントが必要です。
- JavaScript の知識か、検索する力が必要です。
Step 1 – 文書化するエラーを探しましょう
- Firefox/Gecko のエラーメッセージ: https://dxr.mozilla.org/mozilla-central/source/js/src/js.msg
- Edge/Chakra のエラーメッセージ: https://github.com/Microsoft/ChakraCore/blob/master/lib/Parser/rterrors.h
- Chrome/v8 のエラーメッセージ: https://github.com/v8/v8/blob/master/src/messages.h#L75
Step 2 – 既存のエラードキュメントを探しましょう
- 既存の JavaScript エラーメッセージを見て、エラーの文書化される方法を見てみます。
- 書こうとするエラーの種類によっては、このページを詳細に見ます。
- 新しいエラーページをキックオフするのに、既存のエラーページのコンテンツをコピーしたくなるかもしれません。
Step 3 – 新しいページを作成します
- すべてのエラーページはこの木の下にあります: /docs/Web/JavaScript/Reference/Errors
- このリンクに従ってサブページを作成できます。
Step 4 – ページの内容を書きます
- 既存のエラードキュメントから構造をコピーして使うか、最初からスタートするかのいずれでも。あなたの選択です!
- 少なくとも次のものが要ります:
- いろいろなブラウザーで投げられるメッセージを含んだ文法ボックス
- エラーの種類
- エラーが発生する理由と、その結果を説明したテキスト。メッセージの投げられた背景まで
- エラーを展示する例 (1 つ以上要ります!) とコードを修正する方法の例
- MDN 上のその他のリファレンスへのポインター