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.
2.3 KiB
2.3 KiB
註解你的程式碼
指示
乾淨且有良好註解的程式碼對於維護和分享你的專案至關重要。在這次作業中,你將練習專業開發者最重要的習慣之一:撰寫清晰且有幫助的註解,解釋程式碼的目的和功能。
檢查你遊戲資料夾中的目前 app.js 檔案,找出可以添加註解和整理的地方。程式碼很容易變得混亂,現在是一個好機會添加註解,確保你的程式碼易於閱讀,方便日後使用。
你的任務包括:
- 添加註解,解釋每個主要程式碼區塊的功能
- 記錄函數,清楚描述它們的目的和參數
- 將程式碼組織成邏輯區塊,並添加區塊標題
- 移除任何未使用或冗餘的程式碼
- 使用一致的變數和函數命名規範
評分標準
| 評分標準 | 優秀 | 合格 | 需要改進 |
|---|---|---|---|
| 程式碼註解 | app.js 程式碼完全有清晰且有幫助的註解,解釋所有主要區塊和函數 |
app.js 程式碼有基本的註解,解釋大部分區塊 |
app.js 程式碼幾乎沒有註解,缺乏清晰的解釋 |
| 程式碼組織 | 程式碼以邏輯區塊組織,具有清晰的區塊標題和一致的結構 | 程式碼有一些組織,基本分組相關功能 | 程式碼有些混亂,難以理解 |
| 程式碼品質 | 所有變數和函數使用描述性名稱,沒有未使用的程式碼,遵循一致的規範 | 大部分程式碼遵循良好的命名規範,幾乎沒有未使用的程式碼 | 變數名稱不清楚,包含未使用的程式碼,風格不一致 |
免責聲明:
此文件已使用 AI 翻譯服務 Co-op Translator 進行翻譯。儘管我們努力確保準確性,但請注意,自動翻譯可能包含錯誤或不準確之處。原始文件的母語版本應被視為權威來源。對於關鍵信息,建議使用專業人工翻譯。我們對因使用此翻譯而引起的任何誤解或誤釋不承擔責任。