Mã Python của bạn có thể đọc được không?

Mar 03 2023

Khi bắt tay vào học viết mã Python, tôi chú ý đến các chi tiết về cách viết mã của mình. Không chỉ chức năng của nó, mà còn đảm bảo rằng mã của tôi tuân theo các phương pháp hay nhất và có thể dễ dàng được giải thích bởi những người khác. Đây là một thói quen quan trọng cần kết hợp để nếu một ứng dụng web được tạo hoặc một phần của cơ sở mã được viết trong tương lai, các kỹ sư phần mềm khác có thể dễ dàng xem mã đang làm gì và có thể sửa đổi công việc. Tôi đã tham khảo Hướng dẫn về Phong cách PEP 8 dành cho mã Python để có được bức tranh rõ ràng hơn về cách thực hành mã Python tốt nhất.

Trong Python, khoảng trắng thường được ưu tiên hơn các tab. Nếu bạn chọn làm như vậy, bạn có thể sử dụng mã — nhưng không nên trộn lẫn các tab và dấu cách! Tầm quan trọng của tính nhất quán sẽ là một chủ đề lặp đi lặp lại trong blog này. Đối với con người, chúng ta sẽ dễ dàng đọc và hiểu nội dung hơn nếu nội dung đó nhất quán. Nhận dạng nên bao gồm bốn không gian. Trong ví dụ dưới đây, chữ in được thụt vào 4 khoảng cách từ đầu dòng đầu tiên.

Trong Python, một dòng nên được giới hạn trong 75 ký tự. Nếu mã của bạn vượt quá giới hạn 75 ký tự, bạn có thể sử dụng thụt lề treo để di chuyển mã bị tràn sang dòng tiếp theo và đảm bảo mã đó vẫn có thể đọc được. Đối với việc thụt lề bàn giao, ưu tiên là sắp xếp mã bị tràn với mã đối chiếu của nó ở dòng trước đó để dễ đọc hơn. Do đó, treo thụt lề không cần thụt vào bốn khoảng trống. Dưới đây là một ví dụ về tràn mã sử dụng thụt lề treo.

Cũng nên tránh khoảng trắng thừa giữa dấu ngoặc đơn và dấu chấm câu. Đôi khi tôi phải nhắc nhở bản thân rằng tôi đang viết mã, không phải một bài báo học kỳ. Dưới đây là một ví dụ nghiêm trọng về khoảng trắng. Nói chung, bạn nên đọc lại mã của mình để đảm bảo rằng một khoảng trắng thừa không vô tình lọt vào mã của bạn.

Cuối cùng, điều quan trọng là mã Python phải chứa các bình luận và những bình luận này phải dễ đọc. Nhận xét Python phải được viết thành câu hoàn chỉnh và phải bắt đầu bằng chữ in hoa, trừ khi từ đầu tiên là một biến được viết thường. Nếu có nhiều câu trong một bình luận, nên có hai khoảng trắng sau dấu chấm. (Bài tập làm bài cho học kỳ của tôi cuối cùng cũng có ích ở đây!). Nhận xét đặc biệt quan trọng nếu có một đoạn mã có mục đích không rõ ràng.

Có những trường hợp Hướng dẫn Phong cách PEP 8 không có tùy chọn. Trong những trường hợp này, bạn có thể chọn cách bạn muốn tạo kiểu cho mã của mình, nhưng bạn nên cố gắng luôn nhất quán. Hãy nhớ rằng, tính nhất quán là chìa khóa!