Python Từ Cơ bản Đến Nâng cao

Bài 8.7. Python - Quy tắc định dạng hàm

Bạn cần ghi nhớ một số chi tiết khi định dạng các hàm. Các hàm nên có tên mô tả và các tên này nên sử dụng chữ thường và dấu gạch dưới. Tên mô tả giúp bạn và người khác hiểu mã của bạn đang cố gắng làm gì. Tên module cũng nên tuân theo các quy ước này.

Mỗi hàm nên có một chú thích giải thích ngắn gọn những gì hàm làm. Chú thích này nên xuất hiện ngay sau định nghĩa hàm và sử dụng định dạng docstring. Trong một hàm được tài liệu hóa tốt, các lập trình viên khác có thể sử dụng hàm chỉ bằng cách đọc mô tả trong docstring. Họ nên có thể tin tưởng rằng mã hoạt động như được mô tả, và miễn là họ biết tên của hàm, các đối số mà nó cần và loại giá trị mà nó trả về, họ nên có thể sử dụng nó trong các chương trình của họ.

Nếu bạn chỉ định một giá trị mặc định cho một tham số, không nên sử dụng khoảng trắng ở cả hai bên của dấu bằng:

def function_name(parameter_0, parameter_1='default value')

Quy ước tương tự nên được sử dụng cho các đối số từ khóa trong các lệnh gọi hàm:

function_name(value_0, parameter_1='value')

PEP 8 (https://www.python.org/dev/peps/pep-0008) khuyến nghị rằng bạn giới hạn các dòng mã ở 79 ký tự để mỗi dòng có thể nhìn thấy trong một cửa sổ trình soạn thảo có kích thước hợp lý. Nếu một tập hợp các tham số khiến định nghĩa của một hàm dài hơn 79 ký tự, nhấn ENTER sau dấu ngoặc đơn mở trên dòng định nghĩa. Trên dòng tiếp theo, nhấn phím TAB hai lần để tách danh sách các đối số khỏi thân hàm, thân hàm sẽ chỉ được thụt lề một mức.

Hầu hết các trình soạn thảo tự động căn chỉnh bất kỳ dòng đối số bổ sung nào để khớp với thụt lề mà bạn đã thiết lập trên dòng đầu tiên:

def function_name(
    parameter_0, parameter_1, parameter_2,
    parameter_3, parameter_4, parameter_5):
    function body...

Nếu chương trình hoặc module của bạn có nhiều hơn một hàm, bạn có thể tách từng hàm bằng hai dòng trống để dễ dàng nhìn thấy nơi một hàm kết thúc và hàm tiếp theo bắt đầu.

Tất cả các lệnh nhập (import) nên được viết ở đầu tệp. Ngoại lệ duy nhất là nếu bạn sử dụng chú thích ở đầu tệp để mô tả chương trình tổng thể.