1. Coding Conventions là gì?
Coding Conventions là tập hợp các hướng dẫn về phong cách (style guidelines) cho ngôn ngữ lập trình. Coding Conventions có thể là các quy tắc quy định bởi nhóm hoặc cá nhân.
Chúng thường bao gồm:
- Quy tắc khai báo và đặt tên cho biến và hàm Các suy tắc sử dụng cho khoảng trắng, thụt đầu dòng và comments.
- Các ví dụ thực hành và quy tắc lập trình.
Coding Conventions đảm bảo chất lượng:
- Cải thiện khả năng đọc code
- Làm cho việc bảo trì code dễ dàng hơn
Thường xuyên sử dụng một loại Coding Convention cho tất cả Javascript Project của bạn.
2. Các chuẩn Javascript Coding Conventions phổ biến
2.1. Google JavaScript Style Guide
Đây là Google JavaScript Style, một chuẩn quy định cách viết mã nguồn trong ngôn ngữ lập trình JavaScript, được Google thiết lập cho tất cả các mã nguồn mở mà họ công bố. Nó không chỉ liên quan đến việc làm cho mã nguồn trở nên thẩm mỹ từ góc độ biểu diễn mà còn đề cập đến các quy tắc và quy ước viết mã khác. Điều quan trọng là Google JavaScript Style tập trung vào việc xác định các quy tắc cụ thể và dễ áp dụng, tránh những lời khuyên không rõ ràng và mơ hồ, bảo đảm rằng tất cả những người tham gia, cả con người và công cụ, đều có thể tuân thủ dễ dàng.
+ Tài liệu Google Javascript Style: https://google.github.io/styleguide/jsguide.html
2.2. Airbnb JavaScript Style
Đây là một bộ quy tắc lập trình tiêu chuẩn mà khách hàng của tôi đã gợi ý sử dụng cho một dự án React. Bộ quy tắc này được định nghĩa và phát triển bởi công ty Airbnb. Nó không chỉ giúp đảm bảo tính chuẩn mực trong việc viết mã cho Javascript ECMAScript ES5 và ES6 mà còn áp dụng cho React và SASS.
Tài liệu Airbnb Coding Conventions cho:
+ ECMAScript 5: https://github.com/airbnb/javascript/tree/es5-deprecated/es5
+ ECMAScript 6: https://github.com/airbnb/javascript
+ React: https://github.com/airbnb/javascript/blob/master/react
+ CSS-in-JavaScript: https://github.com/airbnb/javascript/blob/master/css-in-javascript
2.3. Mozilla Coding style
Mozilla nổi tiếng với trình duyệt cáo lửa Firefox, họ còn là công ty tham gia phát triển ngôn ngữ Javascript và cũng định nghĩa ra bộ coding convention riêng. Bô coding conventions của Mozilla không chỉ dành cho Javascript mà còn định nghĩa chuẩn cho cả C++, Java
+ Tài liệu Mozilla Coding style: https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style
2.4. Jquery Style Guide
JQuery là một thư viện JavaScript phổ biến nhất trên toàn thế giới cho đến nay. Hầu hết các trang web hiện nay đều tích hợp thư viện JQuery vào mã nguồn của họ. Đây là lý do tại sao chúng tôi đã tìm thấy tài liệu về quy tắc viết mã (coding conventions) dành cho JQuery.
+ Tài liệu Jquery Coding Style: https://contribute.jquery.org/style-guide/js/
Bên cạnh đó, có nhiều tài liệu về quy tắc viết mã được xác định bởi các công ty và tổ chức khác nhau. Tôi hi vọng bạn có thể lựa chọn tài liệu phù hợp để phát triển dự án JavaScript của mình với chất lượng cao. Riêng tôi, tôi sẽ đề nghị bạn sử dụng hai bộ quy tắc viết mã của Google và Airbnb.