Tên Package

Tên package trong java được quy ước đặt theo tên miền (com, org, net,…) các hậu tố phía sau tên miền phụ thuộc vào tổ chức hoặc quy định nội bộ riêng của dự án.

package com.cafeincode.backend.controller;
package com.cafeincode.frontend.view;

Tên Class

Tên lớp quy định chung phải là danh từ, chữ cái đầu của mỗi từ được viết hoa

public class Category{
}

public class Keywords{
}

public class CategorySpecial{
}

Tên Interface

Tên interface quy định chung thường là tính từ, tuy nhiên có một vài trường hợp đặc biệt interface đại diện cho một họ các lớp thì là danh từ: List, Map,…

public interface Serializable {}

public interface Clonable {}

public interface Iterable {}

public interface List {}

Tên phương thức

Phương thức đại diện cho hành động mà nó xử lý vì vậy tên phương thức phải là động từ, nên đặt tên phương thức dạng Camel Case.

Category getById(Long id);

List<Category> getAllCategory();

List<Category> getCategoryMenu();

Đặt tên biến

Tên biến tĩnh, biến tham số đối tượng phải được đặt tên rõ ràng, nêu bật mục đích sử dụng của biến, nên đặt theo dạng Camel Case.

public Long id;

private CategoryService categoryService;

private UserFormValidator userFormValidator;

Đặt tên hằng số

Tên hằng số toàn bộ là chữ in hoa, đối với hằng số có nhiều từ thì đặt cách nhau bởi dấu gạch dưới “_”

public static final String SUCCESS = "1";
public static final String ERROR = "0";

Đặt tên Enums

Tương tự như hằng số, chúng ta đặt tên các phần tử liệt kê trong Enums dạng chữ in hoa, có nhiều từ thì cách nhau bởi dấu gạch dưới “_”

public enum EnumStatus {

DRAFT,
 PUBLIC,
 DELETED;
}

Đặt tên Annotations

Tên annotations đặt in hoa chữ cái đầu của mỗi từ, tùy theo nhu cầu và mục đích sử dụng mà annotations là tính từ, động từ, danh từ khác nhau.

public @interface FunctionalInterface {}

public @interface Deprecated {}

public @interface Documented {}

public @Async Documented {

public @Test Documented {}

Xem thêm các bài viết liên quan dưới đây: