You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
3.2 KiB
3.2 KiB
コードにコメントを追加する
指示
きれいで適切に文書化されたコードは、プロジェクトを維持し共有するために不可欠です。この課題では、プロの開発者としての最も重要な習慣の一つである、コードの目的と機能を明確に説明するコメントを書く練習をします。
ゲームフォルダ内の現在の app.js ファイルを確認し、コメントを追加して整理する方法を見つけてください。コードはすぐに手に負えなくなることがありますので、今が読みやすいコードを確保するためにコメントを追加する良い機会です。後で再利用できるようにしましょう。
あなたのタスクは以下を含みます:
- コメントを追加して、コードの各主要セクションが何をしているか説明する
- 関数を文書化し、その目的とパラメータを明確に記述する
- コードを整理し、セクションヘッダーを使って論理的なブロックに分ける
- 未使用または冗長なコードを削除する
- 変数や関数の命名規則を統一する
評価基準
| 基準 | 優秀 | 適切 | 改善が必要 |
|---|---|---|---|
| コードの文書化 | app.js のコードが完全にコメントされており、すべての主要セクションと関数に対して明確で役立つ説明がある |
app.js のコードが適切にコメントされており、ほとんどのセクションに基本的な説明がある |
app.js のコードにコメントがほとんどなく、明確な説明が欠けている |
| コードの整理 | コードが論理的なブロックに整理されており、明確なセクションヘッダーと一貫した構造がある | コードがある程度整理されており、関連する機能が基本的にグループ化されている | コードがやや整理されておらず、理解しにくい |
| コードの品質 | すべての変数と関数が説明的な名前を使用しており、未使用のコードがなく、一貫した規則に従っている | ほとんどのコードが良い命名規則に従っており、未使用のコードが最小限である | 変数名が不明確で、未使用のコードが含まれており、スタイルが一貫していない |
免責事項:
この文書はAI翻訳サービスCo-op Translatorを使用して翻訳されています。正確性を追求しておりますが、自動翻訳には誤りや不正確な部分が含まれる可能性があります。元の言語で記載された文書を正式な情報源としてお考えください。重要な情報については、専門の人間による翻訳を推奨します。この翻訳の使用に起因する誤解や誤解について、当社は一切の責任を負いません。