5.8 KiB
แสดงความคิดเห็นในโค้ดของคุณ
คำแนะนำ
โค้ดที่สะอาดและมีการบันทึกอย่างดีเป็นสิ่งสำคัญสำหรับการดูแลและแบ่งปันโปรเจกต์ของคุณ ในงานนี้ คุณจะได้ฝึกฝนหนึ่งในนิสัยที่สำคัญที่สุดของนักพัฒนามืออาชีพ: การเขียนความคิดเห็นที่ชัดเจนและมีประโยชน์เพื่ออธิบายวัตถุประสงค์และการทำงานของโค้ดของคุณ
ตรวจสอบไฟล์ app.js ในโฟลเดอร์เกมของคุณ และหาวิธีเพิ่มความคิดเห็นและจัดระเบียบโค้ดให้เรียบร้อย โค้ดสามารถยุ่งเหยิงได้ง่าย และนี่เป็นโอกาสที่ดีในการเพิ่มความคิดเห็นเพื่อให้โค้ดของคุณอ่านง่ายและสามารถใช้งานได้ในภายหลัง
งานของคุณประกอบด้วย:
- เพิ่มความคิดเห็น เพื่ออธิบายว่าแต่ละส่วนสำคัญของโค้ดทำอะไร
- บันทึกฟังก์ชัน พร้อมคำอธิบายที่ชัดเจนเกี่ยวกับวัตถุประสงค์และพารามิเตอร์
- จัดระเบียบโค้ด ให้เป็นบล็อกที่มีเหตุผลพร้อมหัวข้อส่วน
- ลบ โค้ดที่ไม่ได้ใช้งานหรือซ้ำซ้อน
- ใช้การตั้งชื่อ ตัวแปรและฟังก์ชันที่สอดคล้องกัน
เกณฑ์การประเมิน
| เกณฑ์ | ดีเยี่ยม | เพียงพอ | ต้องปรับปรุง |
|---|---|---|---|
| การบันทึกโค้ด | โค้ดใน app.js มีความคิดเห็นที่ชัดเจนและมีประโยชน์สำหรับทุกส่วนสำคัญและฟังก์ชัน |
โค้ดใน app.js มีความคิดเห็นที่เพียงพอพร้อมคำอธิบายพื้นฐานสำหรับส่วนใหญ่ |
โค้ดใน app.js มีความคิดเห็นน้อยและขาดคำอธิบายที่ชัดเจน |
| การจัดระเบียบโค้ด | โค้ดถูกจัดระเบียบเป็นบล็อกที่มีเหตุผลพร้อมหัวข้อส่วนที่ชัดเจนและโครงสร้างที่สอดคล้องกัน | โค้ดมีการจัดระเบียบบางส่วนพร้อมการจัดกลุ่มฟังก์ชันที่เกี่ยวข้อง | โค้ดค่อนข้างยุ่งเหยิงและยากต่อการติดตาม |
| คุณภาพของโค้ด | ตัวแปรและฟังก์ชันทั้งหมดใช้ชื่อที่อธิบายได้ ไม่มีโค้ดที่ไม่ได้ใช้งาน และปฏิบัติตามรูปแบบที่สอดคล้องกัน | โค้ดส่วนใหญ่ปฏิบัติตามการตั้งชื่อที่ดี มีโค้ดที่ไม่ได้ใช้งานน้อยมาก | ชื่อตัวแปรไม่ชัดเจน มีโค้ดที่ไม่ได้ใช้งาน และรูปแบบไม่สอดคล้องกัน |
ข้อจำกัดความรับผิดชอบ:
เอกสารนี้ได้รับการแปลโดยใช้บริการแปลภาษา AI Co-op Translator แม้ว่าเราจะพยายามให้การแปลมีความถูกต้อง แต่โปรดทราบว่าการแปลโดยอัตโนมัติอาจมีข้อผิดพลาดหรือความไม่ถูกต้อง เอกสารต้นฉบับในภาษาดั้งเดิมควรถือเป็นแหล่งข้อมูลที่เชื่อถือได้ สำหรับข้อมูลสำคัญ ขอแนะนำให้ใช้บริการแปลภาษามืออาชีพ เราไม่รับผิดชอบต่อความเข้าใจผิดหรือการตีความผิดที่เกิดจากการใช้การแปลนี้