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.1 KiB
2.1 KiB
用註解說明您的程式碼
指示
乾淨、良好註解的程式碼對於維護和共享您的專案是必不可少的。在這個作業中,您將練習專業開發者最重要的習慣之一:撰寫清晰、有幫助的註解,以解釋您的程式碼的目的和功能。
檢視您遊戲資料夾中目前的 app.js 檔案,尋找為它加入註解並整理程式碼的方法。程式碼很容易失控,現在是增加註解的好機會,以確保您的程式碼可讀,方便日後再次使用。
您的任務包含:
- 新增註解說明每個主要區塊程式碼的用途
- 註解函式並清楚描述其目的及參數
- 將程式碼分組為具有區塊標題的邏輯區塊
- 刪除任何未使用或多餘的程式碼
- 使用一致的變數與函式命名慣例
評分規準
| 評分標準 | 優秀 | 適中 | 需改進 |
|---|---|---|---|
| 程式碼註解 | app.js 程式碼完整註解,對所有主要區塊及函式都有清楚有用的說明 |
app.js 程式碼有適當註解,對大部分區塊有基本說明 |
app.js 程式碼註解極少,缺乏清楚說明 |
| 程式碼組織 | 程式碼有條理地分組為具明確區塊標題的邏輯區塊,結構一致 | 程式碼稍有組織,對相關功能有基本分組 | 程式碼結構較混亂、不易理解 |
| 程式碼品質 | 所有變數和函式皆使用具描述性的命名,無未使用的程式碼,遵循一致慣例 | 大部分程式碼使用良好命名,僅少量未使用程式碼 | 變數命名不清楚,有未使用程式碼,風格不一致 |
免責聲明:
本文件係使用 AI 翻譯服務 Co-op Translator 進行翻譯。雖然我們力求準確,但請注意,自動翻譯可能包含錯誤或不準確之處。原始文件的母語版本應視為權威來源。對於重要資訊,建議尋求專業人工翻譯。因使用本翻譯所產生之任何誤解或誤譯,本公司概不負責。