Mã sạch trong javascript

Code sạch là điều mà mọi dev đều mong muốn đạt được. Tuy nhiên, làm sao để thực hiện điều đó là cả một vấn đề. Dưới đây là 5 cách để viết mã sạch bằng JavaScript, giúp bạn dễ dàng hơn trong việc diễn tả ý tưởng cũng như mở rộng thêm các chức năng mới sau này.  

lục mục

Sử dụng tên biến có ý nghĩa

Vui lòng đặt tên cho biến có nghĩa ngay từ lệnh cấm đầu tiên để có thể biết chính xác nó là gì khi mới nhìn vào

Ví dụ, nếu bạn đang lưu trữ tên của một người, hãy đặt biến tên của bạn là “firstname” thay vì “fn” hay “fnm”,… Nếu không, sau một thời gian không xem lại, chắc chắn bạn sẽ không

Viết một thông báo lỗi rõ ràng

Đặt mình vào vị trí của người dùng, chắc chắn rằng bạn sẽ thật khó chịu hay khi nhìn thấy dòng. “Lỗi” nhưng không biết nó là lỗi gì và cũng không biết rằng sẽ làm gì tiếp theo.  

Do đó, hãy viết một dòng báo lỗi rõ ràng rõ ràng để họ biết cần phải làm gì ở bước tiếp theo.  

Ví dụ. Nếu muốn thông báo lỗi do không kết nối được internet, bạn có thể viết như sau

showMessage('Không có kết nối internet. Vui lòng kiểm tra kết nối của bạn và thử lại. ’);

Hoặc nếu người dùng quên nhập thông tin, bạn có thể thông báo như sau

showMessage('Vui lòng nhập tên người dùng của bạn');

Quan trọng hơn, rõ ràng lỗi giúp bạn gỡ lỗi nhanh chóng và tiết kiệm nhiều thời gian phát triển

Mỗi chức năng chỉ nên làm một nhiệm vụ

Mỗi chức năng chỉ nên làm một nhiệm vụ. Don't to the functions must be "kiem task" many job.  

Ví dụ

chức năng xác thựcAndLogin() {

// Làm nhiều thứ ở đây

}

“And” ở đây không được coi là một phần của tên hàm. “And” giữ nhiều nhiệm vụ hơn trong một chức năng, điều này gây hại nhiều hơn lợi về lâu dài. Bạn có thể thử giải pháp dưới đây

chức năng xác thực() {

// Chỉ xác thực

}đăng nhập chức năng() {

// Chỉ đăng nhập

}

Tạo mô-đun

Thay vì tạo một số Hàm để thực hiện một loại hành động tương tự nhau như validateUsername và validatePassword, bạn có thể nhóm chúng lại với nhau thành một mô-đun và nó được gọi là mô-đun xác thực

Sử dụng Plugin định dạng mã

Nếu đang dùng VSCode thì nên cài Prettier vì code đẹp. Plugin này sẽ giúp bạn tiết kiệm thời gian định dạng mã. Nhờ đó, bạn có thể dành thời gian đó để tập trung hơn vào mã chất lượng của mình

Use function in when code

Quy ước mã hóa là tập hợp các nguyên tắc chung khi lập trình như đặt tên biến, hàm, tệp, lớp, nhận xét,…, giúp mã dễ đọc, dễ hiểu. Từ đó, công việc quản lý, bảo trì và công việc cũng trở nên dễ dàng hơn.   

Cấu hình mã đoạn cấu trúc rõ ràng

Bạn nên sử dụng tên, số lượng, xuống hàng và bình luận hợp lý để giữ cho đoạn mã của mình được thu gọn với các nguyên tắc sau

Quy tắc đặt tên (quy ước đặt tên)

• Cú pháp lạc đà (camelCase). Các ký tự đầu tiên của từ đầu tiên viết thường và các ký tự đầu tiên của các từ tiếp theo được viết hoa
  • Ví dụ. sản phẩmGiá, lạc đàCasing, thisIsTheNameThatFollowTheCamelCase
• Cú pháp Pascal (PascalCase). viết hoa chữ cái đầu tiên của mỗi từ
  • Ví dụ. ProductName, PascalCasing, ThisIsTheNameThatFollowThePascalCase
• Cú pháp con rắn (snake_case). Tất cả các chữ cái đều viết thường, và các từ cách nhau bằng dấu gạch dưới
  • Ví dụ. user_name, this_is_the_name_that_follow_the_snake_case

Quy tắc về số lượng

Bob Martin phát biểu trong cuốn sách Clean Code. “nếu nhỏ là tốt, thì nhỏ hơn phải tốt hơn”. Số lượng mã dòng trong chức năng/lớp, số lượng gói hàm trong lớp, số lượng trong lớp phải giữ ở giới hạn nhất định nào đó và nên giữ càng ít càng tốt, ví dụ

• Hàm không nên quá 30 dòng
• Lớp không nên vượt quá 500 dòng
• Một hàm không được vượt quá 5 tham số, (nên giữ <=3)
• Một hàm chỉ làm duy nhất 1 công việc, trong một số trường hợp, có thể sử dụng để thực hiện 2 công việc cùng một lúc, tuy nhiên tên hàm phải được xác định rõ điều này
  • ví d. tăngDownloadCounterAndSaveToDatabase
• Khi khai báo biến, một dòng chỉ chứa một biến
• Một dòng không nên dài quá 80 ký tự
• Các câu lệnh lồng nhau tối đa 4 cấp

Quy tắc xuống hàng

• If has comcomes, down the row after comcom (,)
• Xuống hàng trước toán tử +, – …
• Nếu có nhiều cấp lồng nhau thì xuống hàng theo từng cấp
• Dòng xuống hàng mới thì nên bắt đầu ở cùng cột với đoạn lệnh cùng cấp ở trên

Bình luận

• Hủy chế độ sử dụng bình luận để giải mã, thay vào đó hãy cải thiện đoạn mã
• Chỉ nên dùng comment trong trường hợp viết tài liệu cho thư viện, thông tin đính kèm cho lớp…

Sử dụng tư duy

Thay vì Copy – Paste từ bất kỳ trang nào hoặc ở đâu thì bạn hãy học cách tự tư duy. Sao chép chỉ giúp giải quyết vấn đề hiện tại, còn lại trong tương lai sẽ khiến bạn mất dần đi khả năng mã tự. Bạn có thể sao chép những gì không biết nhưng bạn cần hiểu ý nghĩa, chức năng trước khi thực hiện

Clean code rất quan trọng, giúp bạn dễ dàng hơn trong việc bảo trì đối với phần mềm, hay sản phẩm kỹ thuật. Bài viết đã chia sẻ cho các bạn những cách giúp code của mình gọn gàng hơn. Hy vọng những kiến ​​thức trên có thể giúp bạn phát triển những mã kỹ năng của mình