Hiển thị tài liệu hướng dẫn của hàm trong Python
Trong thân hàm, bạn có thể viết một chuỗi ký tự
mô tả bản chất công việc được thực hiện. Chuỗi
như vậy được coi là tài liệu hướng dẫn
của hàm. Nó được đặt trong dấu nháy đơn
và nằm ở dòng đầu tiên trong thân hàm.
Để đọc nó, cần sử dụng
hàm đặc biệt help, tham số của
hàm này truyền vào tên hàm.
Giả sử chúng ta có một hàm tính tổng hai số. Thông tin tương ứng được để lại trong một chuỗi với thông tin tương ứng:
def getSum(num1, num2):
'hàm này tính tổng hai số'
return num1 + num2
Hãy gọi help và xem
những gì được chú thích trong getSum:
help(getSum)
Sau khi thực thi mã, trong console sẽ xuất hiện một chuỗi với tên hàm và tài liệu hướng dẫn của nó:
Help on function getSum in module __main__:
getSum(num1, num2)
hàm này tính tổng hai số
Với hàm help, bạn có thể đọc
tài liệu hướng dẫn của cả các hàm tiêu chuẩn. Hãy
tìm hiểu thông tin về hàm print:
help(print)
Để chỉ hiển thị chuỗi
tài liệu hướng dẫn từ hàm, cần truyền
vào help sau tên hàm một cấu trúc
dịch vụ .__doc__:
help(print.__doc__)
Tạo một hàm nhận một danh sách tên tháng làm tham số và hiển thị chúng với chữ cái đầu viết hoa. Mô tả bản chất công việc của hàm trong tài liệu hướng dẫn và hiển thị nó trong console.
Hiển thị toàn bộ tài liệu hướng dẫn về hàm sum.
Chỉ hiển thị chuỗi tài liệu hướng dẫn về
hàm len.