QUY CÁCH CODING CHUNG

1. Các quy cách về biến số

1.1 Sử dụng tên biến có nghĩa và có thể đọc được

1.2 Hạn chế sử dụng các từ không cần thiết

1.3 Hạn chế sử dụng các tên biến, tên hàm, tên class hơi giống nhau

Nếu đặt tên quá giống nhau thì khi đọc code sẽ mất khá nhiều thời gian để phân biệt
các tên đó => làm giảm hiệu suất, dễ nhầm lẫn dẫn tới bị lỗi.

1.4 Không sử dụng magic numbers và magic strings

Việc sử dụng magic numbers và magic strings sẽ gây ra các bất lợi sau:
 - Khi người khác đọc code có sử dụng magic numbers và magic strings sẽ không
hiểu được ý nghĩa và mục đích của biến đó.
- Bản thân người code sau một thời gian quay lại đọc code cũng sẽ không nhớ.
- Do code không được dùng chung nên khi cần thay đổi giá trị thì phải sửa nhiều
chỗ dẫn tới sửa sót hoặc nếu không sót thì cũng sẽ mất nhiều thời gian hơn.

1.5 Tránh những comment quá hiển nhiên

Comment cho code là điều cần thiết và được khuyến khích, tuy nhiên đối với các dòng
lệnh quá rõ ràng thì việc thêm comment sẽ trở nên dư thừa không cần thiết.
Khi câu lệnh đã quá rõ ràng thì việc thêm comment là không cần thiết.
Trường hợp bạn vẫn muốn thêm comment hãy kết hợp nó thành một dòng duy nhất là
đủ.

2. Code Grouping
Khi các xử lý bao gồm một vài dòng code thì ta nên nhóm các dòng code này thành
một khối, thêm dòng trắng vào để tách biệt nó với các khối khác.

Đây là một ví dụ:

3. Consistent Naming Scheme
Hiện tại đang có 4 cách đặt tên thông dụng sau:

- camelCase: từ đầu tiên viết thường, các từ tiếp theo viết hoa chữ cái đầu.
- PascalCase: viết hoa tất cả các chữ cái đầu của từng từ có nghĩa.
- snake_case: sử dụng dấu gạch chân giữa các từ, tất cả các từ đều viết thường.
- kebab-case: sử dụng dấu gạch ngang giữa các từ, tất cả các từ đều viết thường.

Mỗi ngôn ngữ lập trình sẽ có quy cách đặt tên khác nhau. Tùy theo ngôn ngữ lập trình
và yêu cầu của dự án chúng ta sẽ sử dụng quy cách đặt tên thích hợp nhưng phải đảm
đảo tính nhất quán trong suốt toàn bộ project.
4. Tránh lồng ghép quá nhiều
Tạo quá nhiều lồng ghép làm cho code trở nên khó đọc, khó theo dõi, dễ dẫn đến sai
sót.

Để tăng tính dễ đọc của source code thì hãy giảm thiếu tối đa số lần lồng ghép của câu
điều kiện if bằng cách thực hiện return sớm nhất có thể.
5. Giới hạn độ dài dòng code
Hãy tránh viết những dòng code quá dài (so với chiều rộng màn hình) làm cho code trở
nên khó đọc.

Hãy thêm ký tự xuống dòng ở chỗ thích hợp và canh chỉnh các câu lệnh cho thẳng
hàng.
6. Viết hoa các từ khóa SQL
Tương tác cơ sở dữ liệu là một phần quan trọng của hầu hết các ứng dụng web. Nếu
đang viết các truy vấn SQL thô, bạn cũng nên giữ cho chúng có thể dễ đọc.

Mặc dù các từ khóa và tên hàm trong SQL không phân biệt chữ hoa chữ thường,
nhưng thông thường nên viết hoa để phân biệt nó với tên bảng và cột của bạn.

7. Không thực hiện quá nhiều cấp xử lý trong một

function
Khi để nhiều cấp xử lý (level of abstraction) trong một hàm thì hàm sẽ trở nên khá dài,
hãy tách hàm thành những hàm nhỏ hơn (mỗi hàm nhỏ là một xử lý đơn giản trong
hàm lớn) sẽ giúp cho code dễ đọc và test hơn.
Ngoài ra việc tách thành những hàm con còn đem lại những ưu điểm sau:

- Tăng tính tái dụng code hơn.

- Khi thực hiên debug sẽ dễ dàng Step Over những xử lý con để tập trung vô
nhũng đoạn code cần theo dõi hơn.
8. Đóng gói điều kiện
Thay vì sử dụng trực tiếp các điều kiện if rải rác khắp cácfile source code thì nên đóng
gói điều kiện bằng một method, bằng cách này thì source code trở nên dễ đọc hơn và
cũng tăng tính bảo trì đặc biệt đối với các câu kiện điện được sử dụng nhiều lần.

9. Tránh các câu điều kiện phủ định

Việc sử dụng câu điều kiện phủ định là không tự nhiên, ngược với logic suy nghĩ thông
thường của con người, và khi cần kiểm tra ngược lại thì lúc đó sẽ cần phủ định một lần
nữa thì logic sẽ càng trở nên mất tự nhiên hơn, dễ sai sót.