Phát triển phần mềm đòi hỏi thiết kế hệ thống tốt và tiêu chuẩn mã hóa. Chúng tôi liệt kê 10 nguyên tắc mã hóa tốt trong sơ đồ bên dưới.
- Tuân theo quy chuẩn Code của ngôn ngữ:
Khi viết mã nguồn, quan trọng là tuân thủ các quy chuẩn ngành công nghiệp đã được thiết lập, như “PEP 8”, “Google Java Style”. Tuân theo một bộ quy chuẩn mã nguồn đã thỏa thuận đảm bảo rằng chất lượng của mã nguồn là nhất quán và dễ đọc. - Tài liệu và Chú thích:
Mã nguồn tốt nên được tài liệu rõ ràng và chú thích để giải thích logic và quyết định phức tạp. Chú thích nên giải thích tại sao một phương pháp cụ thể được chọn (“Tại sao”) thay vì đang thực hiện cái gì (“Cái gì”). Tài liệu và chú thích cần phải rõ ràng, ngắn gọn và được cập nhật liên tục. - Sự Mạnh Mẽ:
Mã nguồn tốt nên có khả năng xử lý nhiều tình huống và đầu vào không mong đợi mà không gây ra lỗi hoặc kết quả không đoán trước được. Phương pháp phổ biến nhất là bắt và xử lý các ngoại lệ. - Tuân theo nguyên tắc SOLID:
“Single Responsibility”, “Open/Closed”, “Liskov Substitution”, “Interface Segregation”, and “Dependency Inversion” – những nguyên tắc này (viết tắt là SOLID) là nền tảng của việc viết mã nguồn có khả năng mở rộng và dễ bảo trì. - Làm cho việc kiểm thử dễ dàng:
Khả năng kiểm thử của phần mềm là quan trọng. Mã nguồn tốt nên dễ kiểm thử, cả bằng cách giảm độ phức tạp của từng thành phần và hỗ trợ kiểm thử tự động để đảm bảo rằng nó hoạt động như mong đợi. - Trừu tượng:
Trừu tượng yêu cầu chúng ta trích xuất logic cốt lõi và ẩn đi sự phức tạp, từ đó làm cho mã nguồn linh hoạt và chung chung. Mã nguồn tốt nên có mức độ trừu tượng vừa phải, không quá thiết kế cũng như không bỏ qua khả năng mở rộng và bảo trì dài hạn. - Sử dụng Design Patterns, Nhưng đừng over-design:
Design patterns có thể giúp giải quyết một số vấn đề phổ biến. Tuy nhiên, mỗi mô hình đều có các tình huống áp dụng của nó. Sử dụng hoặc lạm dụng mô hình thiết kế có thể làm cho mã nguồn của bạn trở nên phức tạp và khó hiểu. - Giảm thiểu sự phụ thuộc toàn cầu:
Nếu sử dụng biến toàn cầu và thể hiện, có thể dễ dàng bị rối trong sự phụ thuộc và quản lý trạng thái hỗn loạn. Mã nguồn tốt nên dựa vào trạng thái cục bộ và truyền tham số. Hàm nên không tạo ra hiệu ứng phụ. - Tối ưu hoá liên tục:
Mã nguồn tốt là có thể bảo trì và mở rộng. Tối ưu hóa liên tục giảm nợ kỹ thuật bằng cách xác định và sửa lỗi càng sớm càng tốt. - Bảo Mật Là Ưu Tiên Hàng Đầu:
Mã nguồn tốt nên tránh các lỗ hổng bảo mật phổ biến.
