Viết clear code như thế nào cho hiệu quả
- Table of Contents
Viết clear code phải rõ ràng là cách tốt nhất để tạo ra một sản phẩm tốt hơn. Viết code
rõ ràng sẽ giúp bạn dễ dàng hiểu và sửa đổi nó, giúp bạn tối ưu hóa hiệu suất và
tối ưu hóa thời gian phát triển. Hãy luôn nhớ rằng viết code rõ ràng là cách tốt nhất để
tạo ra một sản phẩm tốt hơn
Giới thiệu
Viết clear code là một trong những kỹ năng quan trọng nhất của một lập trình viên. Clear code giúp
cho các lập trình viên dễ dàng đọc và hiểu được code của họ, giúp họ dễ dàng tìm ra
và sửa lỗi. Viết clear code cũng giúp cho các lập trình viên dễ dàng chia sẻ code của họ
với nhau. Để viết clear code, các lập trình viên nên sử dụng các tên biến và hàm có ý
nghĩa, sử dụng các comment để giải thích code của họ, sử dụng các khoảng trắng để tạo ra các
khối lệnh rõ ràng, và sử dụng các hàm ngắn gọn để giảm thiểu số dòng code.
Clear Code: Sử Dụng Các Comment Để Giải Thích Code
Bên dưới mình sẽ phân tích chuyển sang clear code là như thế nào cho các bạn xem.
VD: Chương trình tính tổng các tiền trong mảng
Chương trình chưa clear.
Bên dưới là các lỗi do chatGPT check được
Giờ hãy sửa lại cho phù hợp
Chương trình đặt tên đàn hoàn và comment đàn hoàn lại.
Giảm thiểu các comment ghi chương trình chạy như nào, thay vào đó những đoạn code mà quá phức tạp
mà không thể hiểu qua hàm và biến thì ta hãy comment.
Như đoạn code dưới đây bạn có thể bỏ comment đi vì khi đọc vào là người ta hiểu được
biến sum bằng 0 và biết được chương trình bên dưới là tính tổng. và với hàm là tính tổng tiền được hiểu qua tên hàm
Bạn cũng có thể comment code qua tên biến, tên hàm viết sao cho đúng convention của ngôn ngữ và
viết sao cho đồng đội có thể hiểu được.
Clear Code: Lặp qua mỗi phần tử trong mảng sum
Bạn thấy không rất tường mình, nhớ hãy bỏ đi comment vì nhìn vào là bạn biết tính tổng rùi.
Nó được hiểu qua tên biến.
for number in numbers:
# Cộng dồn giá trị của phần tử đó vào biến sum
sum += number
Ví dụ chương trình trên sẽ được tối ưu như thế này.
Dựa vào đoạn code trên bạn có thể nên tách các đoạn code ra và đặt tên cho phù hợp nhìn vào dễ đọc dễ nhớ
Bên trên là một ví dụ đơn giản khi bạn muốn tận dụng và code một cách clear nhất.
Clear Code: In ra giá trị cuối cùng của biến sum
Giờ bạn hãy in ra để xem kết quả.
console.log(sum)
Clear Code: Ví dụ các tên Hàm Để Tách Các Tác Vụ Khác Nhau
1. Tạo Mô Hình: Sử dụng hàm createModel() để tạo mô hình của tác vụ.
- Xây Dựng Các Bước: Sử dụng hàm
buildSteps()để xây dựng các bước cần thiết để thực hiện tác vụ. - Thực Hiện Các Bước: Sử dụng hàm
executeSteps()để thực hiện các bước đã xây dựng. - Kiểm Tra Kết Quả: Sử dụng hàm
verifyResults()để kiểm tra kết quả của tác vụ. - Đánh Giá Kết Quả: Sử dụng hàm
evaluateResults()để đánh giá kết quả của tác vụ. - Viết Code Rõ Ràng Bằng Cách Sử Dụng Tên Biến Cụ Thể-
- // Khai báo biến
let userName;
let userAge;
let userGender;
Đây là một số cách ví dụ đặt tên biến rõ ràng:
// Gán giá trị cho biến
userName = “John Doe”;
userAge = 25;
userGender = “Male”;
// In thông tin ra màn hình
console.log(The user's name is ${userName}, they are ${userAge} years old and their gender is);
${userGender}.
Bạn có thể tách đoạn code của bạn tương tự với mẫu trên cho phù hợp.
Kết luận
Đây là một phần nhỏ để các bạn viết clearCode cho phù hợp. Bài này đơn giản tôi sẽ lên
series từng ngôn ngữ về clear code cho các bạn. Bạn cũng có thể đọc quyển Clean code tiếng Việt
pdf tại đây, hãy mua ủng hộ tác giả nếu có điều kiện.
Với Phần 2 tôi sẽ hướng dẫn mấy bạn dùng chatGPT để clearCode cho đẹp code cho chuẩn đợi nhé
#mtips5s contact
Fanpage: https://www.facebook.com/mtips5s
Group trao đổi, chia sẻ: https://www.facebook.com/groups/mtips5s
Website: https://mtips5s.com
Youtube: https://mtips5s.com
Chúc các bạn thành công!
Các lần chỉnh sửa
- v1.0 10/03/2023: Viết bài
Leave A Comment