Clean code là một trong những thủ thuật quan trọng mà một coder mới hay cũ đều nên biết để có thể nâng cao trình độ Code của mình. Sau đây là một vài quy tắc “clean code” giúp bạn có thể làm chủ kỹ năng này!
Sử dụng danh từ khi đặt tên class (lớp) và áp dụng quy tắc Pascal Case
Đặt tên là một trong những quy ước quan trọng nhất. Việc luôn sử dụng tên có ý nghĩa cho các biến, function và các tên khác sẽ thể hiện được ý nghĩa mục đích của bạn trong chương trình.
Class không thực hiện hành động, có thể hiểu class là khuôn mẫu để tạo ra các đối tượng, vì vậy không nên sử dụng động từ trong tên class.
Ngoài ra, tên class nên áp dụng quy tắc Pascal Case (viết hoa tất cả các chữ cái đầu tiên của mỗi từ). Camel case thường được sử dụng cho các đối tượng.
Viết hoa các giá trị không đổi (Screaming Snake Case)
Luôn sử dụng tên viết hoa đầy đủ cho các hằng số.
Theo quy tắc Screaming Snake Case, tất cả các chữ cái trong một từ được viết hoa và các từ phân tách nhau bằng một dấu gạch dưới.
Tránh đặt tên biến chỉ có một chữ cái
Trong việc viết code, chúng ta thật sự không nên đặt tên biến chỉ có một chữ cái. Tuy nhiên, trong một function nhỏ, đối với vòng lặp, tên biến có một chữ cái cho index có thể chấp nhận được.
Tránh dùng nhiều vòng lặp lồng nhau
Đôi khi chúng ta sử dụng nhiều vòng lặp lồng nhau làm code trở nên rất khó hiểu. Giải pháp ở đây chính là hãy tách tất cả các vòng lặp ra thành các function riêng biệt.
Giả sử chúng ta có một mảng (array) chứa một mảng (firstArr), mảng firstArr này lại chứa một mảng khác (secondArr) và chúng ta muốn lấy ra phần tử của mảng trong cùng (secondArr).
Để xử lý yêu cầu này, thông thường chúng ta hay viết các vòng lặp lồng nhau, tuy nhiên, đây không phải là cách tối ưu nhất. Chúng ta có thể viết một function để giải quyết vấn đề, function này sẽ gọn gàng hơn, ít lặp code hơn, dễ đọc hơn và có thể tái sử dụng.
Không phụ thuộc quá nhiều vào comments
Comments giúp các lập trình viên khác làm việc trong cùng một dự án sau này hiểu code nhanh hơn, dễ dàng hơn. Tuy nhiên, nếu code cần đến comments thì nguyên nhân có thể là do bản thân code chưa đủ rõ ràng, dễ hiểu. Dưới đây là một câu nói nổi tiếng về việc viết comments của Jeff Atwood:
“Comments vốn dĩ không phải là xấu, nhưng cũng không hẳn là tốt, đôi khi người viết code bị phụ thuộc vào comments. Bản thân bạn phải luôn tự ý thức viết code của mình như thể không có comments. Chính vì vậy, hãy viết code theo cách đơn giản nhất, dễ hiểu nhất, rõ ràng nhất có thể”. — Jeff Atwood
Nhìn chung, việc code có comment không phải là xấu, nhưng chính bản thân code của bạn cần phải dễ hiểu, dễ giải thích kể cả khi không có comment.
Tránh viết function quá dài
Khi một function hoặc một class (lớp) quá dài, các coder nên tách chúng thành nhiều phần khác nhau. Điều này sẽ làm cho code của chúng ta clean hơn, dễ hiểu hơn và có thể tái sử dụng.
Giả sử chúng ta cần cộng và trừ hai số. Thông thường chúng ta có thể dùng một function duy nhất, nhưng cách tốt nhất là nên chia thành hai function. Khi viết các function riêng lẻ, chúng ta có thể tái sử dụng chúng trong toàn bộ ứng dụng.
Tránh lặp code
Lặp code có nghĩa là một khối code được sử dụng trong code của bạn nhiều hơn một lần. Khi vướng phải lỗi ngày thì phần code đó của chúng ta nên được viết thành một function.
Lấy từ ví dụ ở trên (mục 2: Tránh dùng nhiều vòng lặp lồng nhau).
Nhìn vào phần Bad practice: Chúng ta đã lặp lại khối code tương tự nhau ba lần.
Cách tối ưu hơn là viết một function có chức năng tương đương, và function đó có thể tái sử dụng.
Xét thêm một ví dụ khác:
Hy vọng một vài quy tắc trên đây có thể giúp ích phần nào cho các bạn muốn thành thạo “vlean code”. Viết clean code không phải là một việc dễ dàng, đòi hỏi nhiều thời gian để luyện tập.
Clean code ban đầu tuy sẽ mất thời gian hơn nhưng về lâu dài sẽ giúp chúng ta tiết kiệm thời gian để đọc code sau này, giúp việc cải tiến và mở rộng dự án trở nên nhanh chóng, dễ dàng hơn.
Chúc các Coder có thể nhanh chóng tạo ra các “code sạch” một cách thành thạo và nhanh chóng!
Bộ môn Công nghệ thông tin
Cao đẳng FPT Mạng cá cược bóng đá
Hà Nội
