Đường dưới chân ta đi

Các quy ước khi lập trình là rất nhỏ, tuy nhiên nếu ta không có một thói quen lập trình tốt thì sau này khó có thể trở thành một Coder chuyên nghiệp được.

Các quy ước về phong cách lập trình:

1>Mọi sự vi phạm đều được cho phép nếu nó giúp cho tối ưu đoạn mã của bạn.
Mục đích chính của các quy tắc này là làm cho mã nguồn dễ đọc hiểu hơn, dễ dàng sửa lỗi và bảo trì, nâng chất lượng chung của mã nguồn. Tuy nhiên, nó sẽ không thể áp dụng đúng với mọi trường hợp cụ thể, và các lập trình viên phải sử dụng mềm dẻo các quy ước này.

2> Đặt tên cho các gói (package) nên bằng chữ in thường toàn bộ:
Ex: mypackage, com.company.application.ui

3> Tên cho các kiểu dữ liệu phải là danh từ, và được viết rõ ràng bởi các từ bắt đầu bằng 1 ký tự in hoa:
Ex: Line, AudioSystem…

4> Tên biến phải bắt đầu bằng một ký tự in thường, các từ tiếp theo được bắt đầu bằng một ký tự in hoa:
Ex: line, audioSystem…

5> Tên hằng phải đặt toàn bộ là chữ in hoa, các từ tách biệt nhau bởi ký tự gạch dưới “_”.
Ex: MAX_ITERATIONS, COLOR_RED…

6> Tên của các phương thức phải là động từ bắt đầu bằng 1 ký tự in thường và các từ tiếp sau được viết rõ ràng bởi các từ bắt đầu bằng 1 kí tự in hoa:
Ex: getName(), computeTotalWidth()…

7> Những từ viết tắt không nên viết toàn các ký tự in hoa (trừ khi nó nằm trong tên hằng).
exportHtmlSource(); // NOT: exportHTMLSource();
openDvdPlayer(); // NOT: openDVDPlayer();

8> Tên Wilted Flowercác biến[/w] cục bộ của lớp nên kết thúc bằng hậu tố “_”
class Person {
private String name_; ...
}

9> Tất cả các tên nên được viết bằng Tiếng Anh

10> Những biến phạm vi rộng nên đặt tên dài, những biến phạm vi hoạt động hẹp (cục bộ) nên đặt tên ngắn.
Ex: numOfEmployees -> Phạm vi rộng, tmp -> Phạm vi hẹp…

11> Từ khóa “set/get” phải được đặt trong các phương thức truy cập trực tiếp đến thuộc tính:
Ex: getName(), setSalary(int)…

12> Tiền tố “is” nên được sử dụng trong các phương thức, hoặc Wilted Flowercác biến[/w] kiểu boolean:
Ex: isEmpty, isOpen…

13> Tiền tố “compute” có thể được sử dụng cho các phương thức tính toán:
Ex: valueSet.computeAverage(); matrix.computeInverse();

14> Từ khóa “find” có thể được sử dụng trong các phương thức tìm kiếm:
Ex: vertex.findNearestVertex(); matrix.findSmallestElement(); node.findShortestPath(Node destinationNode);

15> Các biến JFC (Java Swing) nên được đặt hậu tố là kiểu đối tượng:
Ex: widthScale, nameTextField, leftScrollbar, mainPanel, fileToggle, minLabel, printerDialog

16> Tập hợp nhiều đối tượng nên được đặt tên được đặt tên ở số nhiều:
Ex: Collection<Point> points; int[ values;

17> Những biến chỉ số lượng đối tượng nên có tiền tố “n”:
Ex: nPoints, nLines…

18> Những phần bổ sung nên được sử dụng:
Ex: get/set, add/remove, create/destroy, start/stop, insert/delete, increment/decrement, old/new, begin/end, first/last, up/down, min/max, next/previous, old/new, open/close, show/hide, suspend/resume, etc.