Docstrings của hàm trong Python

Table of Content

Bạn có thể cung cấp tài liệu chỉ dẫn cho mỗi hàm bằng cách đặt một chuỗi ở đầu thân hàm. Chuỗi này được gọi là docstring.

def echo(anything):
    'hàm echo trả về đối số của số'
    return anything

Bạn có thể tạo ra docstring dài hơn, thậm chí định dạng một chút theo ý bạn:

def print_if_true(thing, check):
    '''
    In đối số đầu tiên nếu đối số thứ hai true.
    Hoạt động:
        1. Kiểm tra xem đối số thứ hai có true không?
        2. Nếu có, in đối số đầu tiên.
    '''
    if check:
        print(thing)

Để in docstring của hàm, gọi hàm help(). Truyền tên hàm vào hàm này và nó in các thông tin về hàm như tên hàm, các tham số cùng với docstring của hàm.

>>> def print_if_true(thing, check):
    '''
    In đối số đầu tiên nếu đối số thứ hai true.
    Hoạt động:
        1. Kiểm tra xem đối số thứ hai có true không?
        2. Nếu có, in đối số đầu tiên
    '''
    if check:
        print(thing)
>>> help(print_if_true)
Help on function print_if_true in module __main__:

print_if_true(thing, check)
    In đối số đầu tiên nếu đối số thứ hai true.
    Hoạt động:
        1. Kiểm tra xem đối số thứ hai có true không?
        2. Nếu có, in đối số đầu tiên

Nếu bạn chỉ muốn lấy docstring dưới dạng văn bản thô (không chứa định dạng), thì có thể sử dụng thuộc tính __doc__ của hàm.

>>> print_if_true.__doc__
'\n\tIn đối số đầu tiên nếu đối số thứ hai true.\n\tHoạt động:\n\t    1. Kiểm tra xem đối số thứ hai có true không?\n\t    2. Nếu có, in đối số đầu tiên\n\t'

Leave a Reply