Tài liệu này hướng dẫn phong cách lập trình tại cty VisCom Solution. Mục tiêu là để thống nhất cách code để dễ dàng làm việc giữa các thành viên trong team, giúp bạn thích nghi nhanh với công việc.

Mục tiêu quan trọng nhất là code viết ra dễ đọc, dễ hiểu, không phải vắt óc suy nghĩ đoạn code này dùng làm gì.

Cách đặt tên biến/hàm

Tên biến có chữ cái đầu viết thường, tên hàm chữ cái đầu viết hoa

isSuccess = True
function Foo(){}

Biến toàn cục chữ bắt đầu là g_ còn biến của class bắt đầu bằng m_

m_isSuccess = True
g_numObject = 5

Tên biến, hàm phải rõ nghĩa, không đặt tên chung chung. Trong trường hợp nếu tên biến quá dài thì viết ghi chú cho biến.

m_validPerson = True

Các quy tắc

Hạn chế sử dụng biến toàn cục
Biến toàn cục dễ gây ra các kết quả không dự đoán được. Hãy luôn viết hàm có input/output rõ ràng để chương trình chạy đúng đắn.

Function/class có chức năng rõ ràng cụ thể
Mỗi function/class có chức năng độc lập, xác định được bằng công việc mà function/class thực hiện.

Các ưu tiên

Code chạy được => chạy đúng => chạy nhanh
Nếu theo thứ tự ngược lại hiệu quả công việc sẽ giảm.

Ưu tiên code dễ đọc hơn là code ngắn gọn
Code ngắn gọn nghĩa là dùng các biểu thức phức tạp để giảm số dòng. Cty không cần quá ngắn gọn nếu gây khó đọc, khó bảo trì. Code ngắn gọn, dễ hiểu, dễ bảo trì luôn được ưu tiên.

Các lưu ý

Nguyên tắc đặt ra để công việc tốt hơn, nếu nguyên tắc làm công việc giảm hiệu suất hoặc gây khó khăn hãy nói với người quản lý.