# 註解你的程式碼 ## 指示 乾淨且文件完善的程式碼對於維護和分享你的專案非常重要。在這次作業中,你將練習專業開發者最重要的習慣之一:撰寫清晰、有幫助的註解說明程式碼的目的與功能。 瀏覽你遊戲資料夾中的現有 `app.js` 文件,並尋找可加入註解及整理的方式。程式碼很容易失控,現在是個好機會加入註解,確保程式碼易於閱讀以便日後使用。 **你的任務包括:** - **加入註解** 解釋每個主要程式區塊的功能 - **文件化函式** 清楚描述其用途與參數 - **將程式碼組織** 成合乎邏輯的區塊並加上區段標題 - **移除** 未使用或冗餘的程式碼 - **使用一致的** 變數與函式命名慣例 ## 評分標準 | 標準 | 優異 | 適當 | 需改進 | | -------- | --------- | -------- | ----------------- | | **程式碼文件化** | `app.js` 具有完整註解並對所有主要區塊和函式提供清晰、有幫助的說明 | `app.js` 有適度註解,對大部分區塊提供基本說明 | `app.js` 註解很少且缺少清楚說明 | | **程式碼組織** | 程式碼有合邏輯的區塊,清楚的區段標題和一致結構 | 程式碼有一定組織,基本分組相關功能 | 程式碼組織不良,難以閱讀 | | **程式碼品質** | 變數與函式名稱具描述性,無未使用程式碼,遵守一致慣例 | 大多數程式碼遵守良好命名規範,極少未使用程式碼 | 變數名稱不清楚,包含未使用程式碼,風格不一致 | --- **免責聲明**: 本文件經由 AI 翻譯服務 [Co-op Translator](https://github.com/Azure/co-op-translator) 翻譯而成。儘管我們致力於確保準確性,請注意自動翻譯可能包含錯誤或不準確之處。原始語言文件應被視為權威來源。對於重要資訊,建議採用專業人工翻譯。本公司對因使用本翻譯而引起的任何誤解或曲解概不負責。