Lập trình C: Hướng dẫn viết mã lệnh

A. Cách đặt định danh (identifier)

1. Hãy cho các định danh mang một ngữ nghĩa. Ví dụ, đừng sử dụng các tên chỉ có một chữ cái như a hay i.

2. Hãy làm cho tên định danh dễ đọc. Ví dụ: Sử dụng curentValue thay vì curval.

3. Giữ cho định danh có một độ dài hợp lý.

B. Chữ hoa trong tên biến

1. Sử dụng CHỮ HOA cho các hằng.

2. Hàm: Ký tự đầu là chữ thường, ví dụ: appNme() (trong trường hợp tên hàm gồm nhiều từ: thì từ đầu tiên là chữ thường và sau đó là các ký tự đầu của các từ sau là chữ hoa).

3. Các biến: tên của biến là chữ thường, ví dụ: name (trong trường hợp tên biến gồm nhiều từ: thì từ đầu tiên là chữ thường và sau đó là các ký tự của các từ sau là chữ hoa, ví dụ: firstName).

C. Thụt lề

1. Câu lệnh của bất kỳ khối nào cũng nên thụt vào 2-4 khoảng trắng.

2. Nếu thân của một vòng lặp, câu lệnh if, hoặc mệnh đề else là một câu lệnh đơn (không phải là một khối), thì thụt câu lệnh vào 3 khoảng trắng trên một dòng riêng. Mặc dù không đòi hỏi, nhưng câu lệnh đơn có thể đóng trong dấu ngoặc móc {} để tạo thành một khối. Ví dụ:

3. Đặt mệnh đề else của câu lệnh if trên một dòng riêng, nhưng độ sâu thụt vào bằng độ thụt của câu lệnh if của nó. Ví dụ:

4. Nếu một một câu lệnh if đơn là thân của một mệnh đề else, thì câu lệnh if nên viết tiếp theo từ else trên cùng một dòng, và thân của câu if nên thụt vào 3-4 khoảng trắng. Đây là một ngoại lệ của hướng dẫn C.3 ở trên, và nó giữ cho các câu lệnh if lồng nhau khỏi bị thụt về bên phải quá nhanh. Ví dụ:

D. Khoảng trắng

1. Sử dụng các khoảng trắng một cách cẩn thận để tạo sự chú ý vào các đặc điểm thích hợp của một chương trình.

2. Đặt một khoảng trắng sau mỗi dấu phẩy trong danh sách các tham số. Ví dụ: myMethod(int val1, int val2).

3. Đặt một khoảng trắng ở hai bên một toán tử hai ngôi. Ví dụ: if (val1 < val2).

4. Đừng đặt khoảng trắng ngay sau dấu mở ngoặc hoặc trước dấu đóng ngoặc. Ví dụ: if ( val1 < val2 ) <= không nên

5. Đừng đặt khoảng trắng trước dấu chấm phẩy (;) kết thúc câu lệnh.

6. Đặt một khoảng trắng trước dấu mở ngoặc của câu lệnh. Ví dụ: if (val1 < val2)

7. Khi khai báo mảng, kết hợp dấu móc vuông với kiểu dữ liệu, tách biệt với tên biến, để nó áp dụng cho tất cả các biến trên dòng đó (lưu ý là điều này chỉ áp dụng cho C++). Ví dụ: int[30] list1, list2;

8. Khi tham chiếu đến kiểu của một mảng, đừng đặt bất kỳ khoảng trắng nào giữa kiểu phần tử và dấu móc vuông. Ví dụ: int[].

E. Thông báo kết xuất

1. Đừng tỏ ra trịnh thượng.

2. Đừng hài hước.

3. Đầy đủ thông tin nhưng ngắn gọn.

4. Định nghĩa cụ thể các tùy chọn đầu vào trong lời nhắc khi thích hợp.

5. Mô tả các lựa chọn mặc định trong lời nhắc khi thích hợp.

F. Kết xuất

1. Đặt nhãn cho các kết xuất một cách rõ ràng.

2. Trình bày thông tin cho người dùng một cách nhất quán.

Và bây giờ một câu nói sau cùng không chỉ là một “đề nghị”:

Không được lạm dụng biến toàn cục!

Trước khi bạn dịnh nghĩa bất kỳ biến toàn cục nào (một cách chính xác hơn, một thể hiện hay một biến thuộc lớp đã được định ở đầu lớp), hãy chắc chắn rằng nó hết sức cần thiết. Nó có phải là một biến sẽ được sử dụng bởi nhiều hàm khác nhau? Nó có phải là một biến mà nếu không dùng thì hậu quả là nó sẽ xuất hiện trong hầu hết các danh sách tham số?