You are on page 1of 10

Coding

Conventions
1
Tại sao lại cần quy chuẩn mã nguồn

● Giúp mã nguồn dễ đọc, dễ hiểu, dễ gỡ lỗi


● Đảm bảo chất lượng mã nguồn trong trường hợp
chuyển giao cho khách hàng

2
Tệp mã nguồn Java [1]

1. Quy tắc đặt tên


Tên tệp phân biệt chữ hoa chữ thường cộng với phần
mở rộng .java

3
Tệp mã nguồn Java [2]

2. Quy tắc tổ chức tệp


● Các phần phải được phân tách bằng các dòng trống và
kèm chú thích (không bắt buộc) mô tả từng phần
● Độ dài tệp không nên vượt quá 2000 dòng
● Độ dài một dòng không nên vượt quá 80 ký tự

4
Tệp mã nguồn Java [3]

2. Quy tắc tổ chức tệp


Cấu trúc tệp bao gồm các phần theo thứ tự:
● Giấy phép hoặc bản quyền (nếu có)
● Câu lệnh xác định gói
● Các câu lệnh import
● Một lớp (top-level) duy nhất

5
Tệp mã nguồn Java [4]

2. Quy tắc tổ chức tệp


Thứ tự các phần trong định nghĩa một lớp:

6
Các câu lệnh trong Java

● Lệnh khai báo, định nghĩa


● Lệnh đơn/Lệnh phức
● Lệnh return
● Lệnh điều khiển (rẽ nhánh, lặp)

7
Cách sử dụng khoảng trắng

● Giữa từ khóa và dấu mở ngoặc đơn


● Sau dấu phẩy
● Giữa các toán tử hai ngôi
● Giữa các câu lệnh trong for
● Sau toán tử ép kiểu

8
Cách đặt tên

● Tên tệp
● Tên lớp
● Tên hàm
● Tên biến
● Tên hằng số

9
Cách comment trong Java

[1] https://www.oracle.com/technetwork/java/codeconventions-150003.pdf
[2] https://google.github.io/styleguide/javaguide.html

10

You might also like