Tuân theo các tiêu chuẩn

Thực tiễn tốt nhất 3 - Tuân theo các tiêu chuẩn đã xác định, không tạo ra nó

Hầu hết các tổ chức phần mềm tiêu chuẩn duy trì các tiêu chuẩn mã hóa của họ. Các tiêu chuẩn này sẽ được thiết lập bởi các nhà phát triển phần mềm có kinh nghiệm tốt sau nhiều năm phát triển phần mềm. Điều này tương đương với việc đi theo bước chân của những người vĩ đại đã bỏ lại phía sau họ.

Nếu tổ chức của bạn không có bất kỳ tiêu chuẩn nào, thì tôi khuyên bạn nên tìm kiếm trên internet về các tiêu chuẩn mã hóa từ các ngôn ngữ lập trình khác nhau và bạn sẽ tìm thấy rất nhiều. Một tiêu chuẩn mã hóa sẽ sửa chữa các quy tắc về các thuộc tính quan trọng khác nhau của mã, một số ít được liệt kê bên dưới:

  • Quy ước đặt tên tệp
  • Quy ước đặt tên chức năng & mô-đun
  • Quy ước đặt tên biến
  • Lịch sử, Thụt lề, Nhận xét
  • Nguyên tắc về khả năng đọc
  • Danh sách những việc nên làm và không nên làm

Nhưng khi đã xác định, hãy bắt đầu tuân theo tiêu chuẩn đã xác định thay vì tạo hoặc thay đổi chúng mỗi ngày. Tôi chắc chắn sẽ nói:

Mã nguồn là BÉ của bạn!

Vì vậy, hãy giữ cho nó sạch sẽ, nhất quán và đẹp mắt. Khi tôi nói đẹp, nó thực sự có nghĩa là đẹp. Nếu mã của bạn trông đẹp, thì người khác sẽ dễ dàng đọc và hiểu nó. Nếu bạn tiếp tục thay đổi các quy tắc mã hóa hàng ngày, thì sau vài ngày, chính bạn sẽ không thể đọc và hiểu mã do bạn viết.