Tiền Tố Và Hậu Tố Trong Tên (Naming Convention)

By | April 20, 2020

Để mã nguồn dễ đọc, dễ hiểu, ta cần có các quy ước đặt tên thống nhất. Dưới đây là những điều cần biết khi đặt tên, các quy ước cần tuân thủ khi tham gia vào các dự án của team

Khái niệm nghiệp vụ

Là các tên gọi, thuật ngữ, … liên quan đến bài toán nghiệp vụ của dự án, được xác định thành các khái niệm cụ thể, rõ ràng và liệt kê trong Từ điển của BA.
Ví dụ: Sản phẩm, đơn hàng, nhà cung cấp, đối tác, …

Khái niệm kĩ thuật

Là các tên gọi, thuật ngữ, … mang tính chất kĩ thuật, xuất phát từ ngôn ngữ lập trình, design pattern, framework hoặc các tên gọi kĩ thuật khác của chuyên ngành mà dự án sử dụng.
Ví dụ: Repository, Service, Model, View, Screen, …

Các quy tắc đặt tên

  • Đặt tên đầy đủ, không viết tắt
  • Tên sử dụng tiếng Anh, tuân theo convention của ngôn ngữ lập trình đang dùng
  • Tên cần có ngữ nghĩa, tránh gây bối rối
    Ví dụ: Tránh đặt các tên giống nhau như: ProductDetail1, ProductDetail2, … Thay vào đó, đặt các tên rõ ràng hơn: ProductBasicDetail, ProductVariationDetail, …
  • Sử dụng khái niệm nghiệp vụ chính liên quan làm tiền tố, sử dụng khái niệm kĩ thuật làm hậu tố
    Ví dụ:
    ProductListScreen: màn hình danh sách Product
    ProductDetailRepository: Repository của màn hình detail của Product

Leave a Reply