Tuân thủ quy chuẩn phong cách code (style guide) giúp đồng bộ code trong team, tăng khả năng đọc và bảo trì. Với Python, tiêu chuẩn phổ biến nhất là PEP 8.
Các quy tắc quan trọng
1. Thụt lề (Indentation)
Dùng tab (hoặc 4 spaces) nhất quán. Không dùng số space ngẫu nhiên.
def sample(random):
# statement 1
# statement 2
return random
2. Encoding
Sử dụng UTF-8 (mặc định Python 3) hoặc ASCII cho môi trường quốc tế.
3. Dấu phẩy cuối trong tuple
Nên thêm dấu phẩy sau phần tử cuối để dễ mở rộng:
tup = (1, 2, 3,)
4. Docstring
Luôn viết docstring cho function/class dùng triple quotes:
def sample():
"""Mô tả ngắn gọn."""
"""
Mô tả chi tiết:
- Dòng 1
- Dòng 2
"""
pass
class Sample:
"""Đây là một class."""
5. Độ dài dòng tối đa 79 ký tự
Ngắt dòng với dấu \ (escape character):
def evaluate(a, b, c, d):
return (2 ** (a + b) / (c // d) ** d + a - d * b) \
- (3 ** (a + b) / (c // d) ** d + a - d * b)
6. Khoảng trắng quanh toán tử và sau dấu phẩy
import random
result = random.randint(1, 3) + random.randint(1, 2)
7. Quy ước đặt tên
- snake_case: biến, hàm →
this_is_function - PascalCase: class →
ThisIsClass - UPPER_SNAKE_CASE: hằng số →
PI_TWO
8. Import mỗi module một dòng
# Không khuyến khích
import math, random
# Khuyến khích
import math
import random
9. Cập nhật comment khi sửa code
Comment lỗi thời gây hiểu lầm. Luôn đồng bộ comment với code.
10. Tránh tên biến đơn ký tự gây nhầm lẫn
Không dùng I (i hoa), l (L thường) vì giống số 1.
11. Không dùng ký tự ASCII trong identifier
Chỉ dùng chữ cái, số, gạch dưới.
Kết luận
Áp dụng PEP 8 giúp code chuyên nghiệp, dễ review và bảo trì. Các công cụ như flake8, black, pylint có thể tự động kiểm tra/format.