3.3 KiB
Bình luận Mã của Bạn
Hướng dẫn
Mã sạch, được tài liệu hóa tốt là rất quan trọng để duy trì và chia sẻ các dự án của bạn. Trong bài tập này, bạn sẽ thực hành một trong những thói quen quan trọng nhất của các nhà phát triển chuyên nghiệp: viết các bình luận rõ ràng, hữu ích để giải thích mục đích và chức năng của mã của bạn.
Hãy xem qua tệp app.js hiện tại trong thư mục trò chơi của bạn và tìm cách thêm bình luận và sắp xếp lại nó. Mã rất dễ trở nên lộn xộn, và đây là cơ hội tốt để thêm các bình luận nhằm đảm bảo rằng bạn có mã dễ đọc để sử dụng sau này.
Nhiệm vụ của bạn bao gồm:
- Thêm bình luận giải thích mỗi phần chính của mã làm gì
- Tài liệu hóa các hàm với mô tả rõ ràng về mục đích và tham số của chúng
- Sắp xếp mã thành các khối logic với tiêu đề phần
- Loại bỏ bất kỳ mã nào không sử dụng hoặc dư thừa
- Sử dụng nhất quán các quy ước đặt tên cho biến và hàm
Tiêu chí đánh giá
| Tiêu chí | Xuất sắc | Đạt yêu cầu | Cần cải thiện |
|---|---|---|---|
| Tài liệu hóa mã | Mã app.js được bình luận đầy đủ với các giải thích rõ ràng, hữu ích cho tất cả các phần và hàm chính |
Mã app.js được bình luận đầy đủ với các giải thích cơ bản cho hầu hết các phần |
Mã app.js có rất ít bình luận và thiếu các giải thích rõ ràng |
| Tổ chức mã | Mã được sắp xếp thành các khối logic với tiêu đề phần rõ ràng và cấu trúc nhất quán | Mã có một số tổ chức với việc nhóm cơ bản các chức năng liên quan | Mã hơi lộn xộn và khó theo dõi |
| Chất lượng mã | Tất cả các biến và hàm sử dụng tên mô tả, không có mã không sử dụng, tuân theo các quy ước nhất quán | Phần lớn mã tuân theo các quy tắc đặt tên tốt với rất ít mã không sử dụng | Tên biến không rõ ràng, chứa mã không sử dụng, phong cách không nhất quán |
Tuyên bố miễn trừ trách nhiệm:
Tài liệu này đã được dịch bằng dịch vụ dịch thuật AI Co-op Translator. Mặc dù chúng tôi cố gắng đảm bảo độ chính xác, xin lưu ý rằng các bản dịch tự động có thể chứa lỗi hoặc không chính xác. Tài liệu gốc bằng ngôn ngữ bản địa nên được coi là nguồn thông tin chính thức. Đối với thông tin quan trọng, nên sử dụng dịch vụ dịch thuật chuyên nghiệp của con người. Chúng tôi không chịu trách nhiệm cho bất kỳ sự hiểu lầm hoặc diễn giải sai nào phát sinh từ việc sử dụng bản dịch này.