Function trong clean code là gì?
Function trong clean code là những hàm được viết sao cho có tính bảo trì và mở rộng cao, dễ đọc, dễ hiểu và có tính tái sử dụng. Các function trong clean code cần phải đảm bảo các nguyên tắc như Single Responsibility Principle (SRP), cụ thể là mỗi function chỉ nên thực hiện một nhiệm vụ duy nhất, Open/Closed Principle (OCP) – mở rộng dễ dàng nhưng không thay đổi bên trong function, và Dependency Inversion Principle (DIP) – tránh phụ thuộc vào các thành phần khác trong code.
Các bài viết liên quan:
Function trong clean code cũng cần phải đặt tên rõ ràng, mô tả chính xác nhiệm vụ của chúng, đảm bảo tính nhất quán với các quy tắc naming convention và sử dụng các tham số và trả về có ý nghĩa.
Một function trong clean code nên được viết ngắn gọn, dễ hiểu và dễ đọc. Nên tránh sử dụng các câu lệnh phức tạp, nested, hay các vòng lặp lồng nhau. Nên sử dụng các biến đặt tên rõ ràng và các comment để giải thích code khi cần thiết.
Tại sao ta cần Function phải clean code
Viết function trong clean code giúp tăng tính bảo trì và mở rộng code, giúp cho code dễ đọc và dễ hiểu hơn. Khi code dễ đọc và hiểu hơn, việc bảo trì, tìm kiếm và sửa lỗi sẽ trở nên dễ dàng hơn, giảm thiểu thời gian và chi phí cho việc bảo trì và phát triển code.
Bên cạnh đó, khi function được viết trong clean code, nó sẽ dễ dàng để kiểm tra, test và xác nhận tính đúng đắn của code. Điều này sẽ giúp tăng tính tin cậy và độ chính xác của chương trình.
Cuối cùng, viết function trong clean code giúp tăng tính tương thích của code. Khi code được viết trong clean code, nó sẽ dễ dàng hơn để đóng gói, tái sử dụng và tích hợp với các module khác trong chương trình. Tính tương thích của code là rất quan trọng để giúp cho chương trình phát triển và mở rộng dễ dàng hơn trong tương lai.
Function clean code sẽ có một số quy tắc
Trong clean code, function là một thành phần rất quan trọng và cần được thiết kế sao cho dễ đọc, dễ hiểu, dễ bảo trì và dễ tái sử dụng. Dưới đây là một số quy tắc và nguyên tắc cần tuân thủ khi thiết kế function trong clean code:
- Độ dài của function: Function nên có độ dài tối đa khoảng 20-30 dòng code. Nếu function quá dài, nó sẽ khó đọc và hiểu hơn, cũng như khó bảo trì và tái sử dụng.
- Tên của function: Tên function nên mô tả rõ ràng về chức năng mà nó đang thực hiện. Tên nên được đặt bằng tiếng Anh và theo quy tắc name convention trong Java.
- Tham số của function: Function nên có số lượng tham số ít nhất có thể và các tham số nên được truyền vào theo thứ tự từ trái sang phải. Nếu số lượng tham số quá nhiều, function sẽ trở nên khó sử dụng và dễ gây ra lỗi.
- Kiểu trả về của function: Kiểu trả về của function nên được đặt rõ ràng và mô tả chính xác về giá trị trả về.
- Thứ tự thực hiện: Function nên được thiết kế sao cho các lệnh trong function được thực hiện theo thứ tự logic của chương trình. Những lệnh quan trọng nên được đặt trước để giảm thiểu lỗi.
- Tránh sử dụng biến toàn cục: Biến toàn cục có thể gây ra rất nhiều rắc rối trong việc quản lý và sử dụng function. Thay vào đó, hãy sử dụng biến cục bộ để truyền giá trị vào và ra khỏi function.
- Tránh sử dụng goto và break: Sử dụng goto và break có thể làm cho code trở nên khó đọc và hiểu hơn. Thay vào đó, hãy sử dụng các vòng lặp và cấu trúc điều kiện để điều khiển luồng chương trình.
- Sử dụng exception thay vì return code: Sử dụng exception sẽ giúp cho code trở nên dễ đọc và hiểu hơn, cũng như giảm thiểu rủi ro xảy ra lỗi trong quá trình thực thi chương trình.
- Đơn giản hóa function: Function nên được thiết kế đơn giản và chỉ thực hiện một nhiệm vụ duy
- Không sử dụng side effects: Function nên không gây ra bất kỳ hiệu ứng phụ nào trên biến toàn cục hoặc các biến ngoài phạm vi của function. Nếu cần phải thay đổi giá trị của một biến ngoài function, hãy truyền giá trị vào function và trả về giá trị mới.
- Sử dụng tên biến rõ ràng: Tên biến nên mô tả rõ ràng về nội dung của biến đó. Tên nên được đặt bằng tiếng Anh và theo quy tắc name convention trong Java.
- Không sử dụng code bị trùng lặp: Nếu có hai function có nội dung tương tự nhau, hãy sử dụng một function chung để tránh việc trùng lặp code.
- Sử dụng comment: Comment là một công cụ hữu ích để giải thích ý nghĩa của function và các lệnh trong function. Tuy nhiên, hãy sử dụng comment một cách hợp lý và không quá dày đặc.
- Sử dụng các công cụ hỗ trợ: Sử dụng các công cụ hỗ trợ như IDE, debugger, profiler, linter, formatter, để giúp đơn giản hóa việc viết và kiểm tra code.
- Kiểm tra và sửa lỗi thường xuyên: Kiểm tra và sửa lỗi thường xuyên sẽ giúp cho code trở nên chất lượng hơn, dễ đọc và bảo trì hơn. Hãy sử dụng các công cụ hỗ trợ để tìm kiếm và sửa các lỗi cú pháp, lỗi logic, lỗi chạy chương trình, v.v.
Những quy tắc và nguyên tắc này sẽ giúp cho function trong clean code trở nên dễ đọc, hiểu và bảo trì hơn. Nếu tuân thủ những quy tắc này, bạn có thể đảm bảo rằng code của mình đạt được chất lượng tốt và đáp ứng được yêu cầu của khách hàng.
