5 tips để code "sạch" mà lập trình viên phải biết

Trong khi bắt học lập trình thì mình chưa biết trình bài code như thế nào là hợp lý, trình bày như thế nào mới đạt và rồi mình có tìm hiểu một số trang để viết code được dễ nhìn và "sạch" hơn, thì vô tình mình tìm thấy trang của anh Phạm Huy Hoàng có chia sẽ cuốn sách có tên là "Clean Code: A HANDBOOK OF AGILE SOFTWARE CRAFTSMANSHIP".

Như cái tên cuốn sách là "Clean Code" là cuốn sách hướng dẫn lập trình viên viết ra "code sạch" do vậy code sạch có nghĩa là code dễ đọc, dễ nhìn, dễ quản lý và sửa chữa.

Những câu nói hay của sách là gì ?

Clean Code có câu nói:

Code cho máy đọc thì ai cũng viết được, code cho người đọc thì chỉ có lập trình viên giỏi mới viết được.

Hãy code như thể thằng lập trình viên bảo trì code của bạn là một thằng sát nhân bệnh hoạn biết địa chỉ nhà của bạn.

Sau đây mình sẽ rút ra những mẹo cần trong khi lập trình.

5 tips phải biết trong lập trình là gì ?

Code của bạn phải được thụt lề tốt

Đầu tiên bạn cần giữ code đơn giản, dễ đọc nhất nếu có thể không cần phức tạp vấn đề. Giúp giải quyết vấn dề nhanh hơn, dễ quản lý hơn khi làm việc nhóm.

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

Nếu bạn đang lưu trữ tên của một người, hãy đặt tên biến của bạn là "firstname" chứ không phải là một cái gì đó như "fn", "fnm", v.v.

Như hình trên là một ví dụ, khi lấy chỉ số cân nặng của một người thì nên đặt tên biến là "weight" không nên đặt tên biến là "cannang", "cn",...

Điều quan trọng rút ra là nên đặt tên biến bằng tiếng anh để làm việc nhóm dễ hiểu hơn, nếu không tin bạn hãy nhìn ví dụ sau đây và sau đó bạn tự nghĩ xem nếu mình để tiếng Việt thì liệu người nước ngoài họ có hiểu mình đang code gì không?

Sử dụng hàm trong khi code

Coding conventions là tập hợp những nguyên tắc chung khi lập trình nhằm làm cho code dễ đọc, dễ hiểu, do đó dễ quản lý, bảo trì hơn.

Coding conventions có những cái chung và cái riêng tuỳ ngôn ngữ, tuỳ cộng đồng, nhưng hầu hết được công nhận và đi theo bởi đa số các lập trình viên trên thế giới.

Lưu ý:

1.Trong khi code chúng ta nên sử dụng hàm để thực thi một nhiệm vụ

Sử dụng tên, số lượng, xuống hàng và comment hợp lý cho các hàm của bạn. giữ cho mã của bạn ngắn gọn

Lưu ý:

2. Quy tắc đặt tên (naming convention)

Cú pháp lạc đà (camelCase)

Ký tự đầu tiên của từ đầu tiên viết thường những ký tự đầu tiên của những từ tiếp theo được viết hoa.

Ví dụ: productPrice, camelCasing, thisIsTheNameThatFollowTheCamelCase

Cú pháp Pascal (PascalCase)

Cú pháp Pascal 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)

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

Bob Martin phát biểu trong cuốn Clean Code: “if small is good, then smaller must be better”.

Số lượng dòng code trong hàm/lớp, số lượng hàm trong lớp, số lượng lớp trong gói phải giữ ở một 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 việc, trong trường hợp chính đáng, làm 2 việc cũng được phép, tuy nhiên tên hàm phải nói rõ điều này, vd: increaseDownloadCounterAndSaveToDatabase
• 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

4.Quy tắc xuống hàng

Theo Oracle

• Nếu có dấu phẩy thì xuống hàng sau dấu phẩy (,)
• 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.

5.Comment

• Hạn chế dùng comment để giải thích code, thay vào đó hãy cải thiện đoạn code.
• Chỉ nên dùng comment trong trường hợp viết documentation cho thư viện, thông tin đính kèm cho class…

Sử dụng bộ não của bạn

Thay vì Ctrl C + Ctrl V từ bất kỳ trang nào hoặc ở đâu đó thì bạn hãy học cách sử dụng bộ não của bạn. Sao chép chỉ giúp giải quyết vấn đề hiện tại, còn trong tương lại sẽ hại bạn mất dần đi khả năng tự code. Hãy sao chép những gì bạn không biết nhưng cố gắng hiểu những gì mình sao chép.

Tạm Kết

Mình nghĩ cũng còn rất nhiều tips hay trên các trang khác, nhưng mà mình thấy 5 tips này cũng không kém phần quan trọng trong việc học lập trình. Chúng ta hãy nhìn vào các cách khác nhau để viết mã sạch, bất kể ngôn ngữ lập trình bạn đang làm việc là gì.

Chúc các bạn thành công!

#5tips #codesach #cleancode