Trong hướng dẫn này, chúng ta sẽ tìm hiểu về hướng dẫn kiểu chuẩn cần tuân theo trong một dự án Python. Việc tuân theo hướng dẫn phong cách chuẩn của bất kỳ ngôn ngữ lập trình nào sẽ giúp tất cả các thành viên trong nhóm ở cùng một tốc độ. Hơn nữa, nó trông chuyên nghiệp.
Đối với Python, hầu hết người dùng làm theo hướng dẫn kiểu PEP 8. Mã trông đẹp và dễ đọc hơn. Bạn có thể tìm thấy danh sách đầy đủ của hướng dẫn phong cách tại đây. Chúng tôi giới thiệu danh sách hướng dẫn kiểu được sắp xếp trong bài viết này.
Sử dụng một tab để thụt lề
Sử dụng tab để thụt lề trong mã làm cho mã dễ đọc hơn thay vì sử dụng khoảng trắng ngẫu nhiên cho nhiều hàm và phương thức. Bạn có thể đặt số lượng khoảng trắng cho một tab trong bất kỳ cài đặt nào của trình chỉnh sửa mã.
Bạn có thể xem một số ví dụ bên dưới.
# example def sample(random): # statement 1 # statement 2 # ... return random
Mã hóa UTF-8 hoặc ASCII mặc định của Pythons '
Sử dụng UTF-8 mặc định của Pythons hoặc ASCII mã hóa là phương pháp tốt nhất cho môi trường quốc tế.
Dấu phẩy theo sau trong bộ mã
Sử dụng dấu phẩy ở cuối trong các bộ giá trị là một trong những phương pháp hay nhất. Nhưng, nó không bắt buộc.
# example tup = (1, 2, 3,)
Sử dụng docstrings
Sử dụng docstring trong các hàm và lớp. Chúng ta có thể sử dụng dấu ngoặc kép ba cho docstrings. Xem một số ví dụ bên dưới.
def sample(): """This is a function""" """ This is a function """ class Smaple: """This is a class""" """ This is a class """
Không viết nhiều hơn 79 ký tự trên một dòng
Bạn không nên viết nhiều hơn 79 ký tự trong một dòng trong PEP 8 hướng dẫn mẫu. Tránh điều này bằng cách ngắt dòng thành nhiều dòng bằng cách sử dụng ký tự thoát () . Xem ví dụ bên dưới.
# example 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)
Sử dụng dấu cách
Đó là một trong những phương pháp hay nhất để sử dụng dấu cách trước và sau một toán tử. Sử dụng dấu cách sau dấu phẩy để dễ đọc hơn.
# example import random result = random.randint(1, 3) + random.randint(1, 2)
Đặt tên biến, hằng số, lớp và hàm
Làm theo trường hợp tương tự cho các biến, hằng số, lớp và hàm trên toàn chương trình. Hầu hết người dùng Python sẽ sử dụng solid_case để đặt tên hàm và biến và PascalCase để đặt tên cho các lớp. Đối với các hằng số, hãy sử dụng tất cả các chữ cái viết hoa được phân tách bằng dấu gạch dưới (ví dụ:- PI_TWO ).
solid_case => this_is_ Chức năng
PascalCase => ThisIsClass
CONSTANT => NÀY_IS_CONSTANT
Đang nhập từng mô-đun
Đừng cố nhập nhiều mô-đun trong một mô-đun mặc dù nó đúng về mặt cú pháp. Xem ví dụ bên dưới.
# don't import math, random # do import math import random
Cập nhật nhận xét
Luôn cập nhật ý kiến của bạn. Đừng quên cập nhật các bình luận trong khi cập nhật mã. Đó là một trong những điều quan trọng nhất trong việc viết mã. Và hầu hết người dùng sẽ quên nó. Hãy ghi nhớ điều này.
Ký tự không được sử dụng riêng lẻ làm tên biến
Chúng tôi có một số ký tự không nên được sử dụng làm tên biến đơn lẻ. Và chúng là I (i viết hoa) và l (L viết thường) vì chúng trông giống với các chữ cái La Mã.
Không sử dụng ký tự ASCII trong số nhận dạng
Sử dụng ASCII các ký tự trong mã định danh hoàn toàn không phải là một thực tiễn tốt. Tránh sử dụng chúng.