Các quy ước về cách đặt tên:
- Đặ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 - 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… - 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… - 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… - 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()… - 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(); - Tên các biến cục bộ của lớp nên kết thúc bằng hậu tố “_”
class Person {
private String name_; ...
} - Tất cả các tên nên được viết bằng Tiếng Anh
- 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… - 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)… - 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… - 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(); - 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); - 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 - Tập hợp nhiều đối tượng nên được đặt tên được đặt tên ở số nhiều:
Ex: Collectionpoints; int[ values; - Những biến chỉ số lượng đối tượng nên có tiền tố “n”:
Ex: nPoints, nLines… - 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.
Theo fotech.org
Không có nhận xét nào:
Đăng nhận xét