オープンソース開発やコミュニティ活動に参加・貢献するには、こちらのページをご覧ください。英語の情報はこちらにあります。ようこそ」をご覧ください。アカウントでログインしてコメントできます。Standard」に遵守します。ドキュメントの形式は、フォーマットされたドキュメントブロックか、インラインコメントになります。ファイル内でドキュメントする項目の例です。短い説明を書く場合には、明確でシンプルな、短い文を心がけてください。「いつ」「何を」実行するのかをドキュメントしてください。「なぜ」を含める必要性はほとんどないはずです。しても「なぜ」が必要であれば長い説明に記述してください。関数やクロージャは「三人称単数」の要素です。説明を記述する場合も「三人称単数の動詞」を使用してください。三人称単数の動詞の活用に悩む場合は、関数やクロージャの説明を書く場合、先頭に「It」をつけて考えてください。blame」の使用を推奨します。Unknown」を使用してください。ドキュメントを編集する際に、ファイル内のコードはリファクタリングしないでください。説明文の要素は完全な文として記述してください。文章ではなく「タイトル」を意図しているためです。内容はコードリファレンス用に正しくパースされます。短い説明:短い説明は単一の文で書き、マークアップしないでください。タグ」のように記述してください。長い説明:長い説明では必要であればマークダウンを使用できます。マークダウンも許されません。タグ」のように記述してください。テキストは80文字分で次の行に折り返してください。20文字分インデントしている場合には、100文字目の位置で折り返します。120文字目以上は超えないでください。コメントの行揃え関連するコメントは可読性を上げるためにスペースを使用して位置を揃えてください。関数は次のようにフォーマットしてください。関数の目的を説明する簡潔な単一の文。