Tài liệu

Nguyên tắc Kỹ thuật Phần mềm với Python

Adam Spannbauer

Machine Learning Engineer at Eastman

Tài liệu trong Python

Chú thích

# Bình phương số x

Docstring

    """Bình phương số x

    :param x: số cần bình phương
    :return: x bình phương

    >>> square(2)
    4
    """

Chú thích

# Đây là một chú thích hợp lệ
x = 2

y = 3  # Đây cũng là một chú thích hợp lệ

# Bạn chỉ thấy tôi khi xem mã nguồn

# Chào các cộng tác viên tương lai!!

Chú thích hiệu quả

Chú thích “cái gì”

# Gán people là 5
people = 5

# Nhân people với 3
people * 3

Chú thích “vì sao”

# Sẽ có 5 người dự tiệc
people = 5

# Cần 3 miếng pizza mỗi người
people * 3

Docstring

def function(x):
    """Mô tả tổng quan về hàm

    Chi tiết bổ sung về hàm

Docstring

def function(x):
    """Mô tả tổng quan về hàm

    Chi tiết bổ sung về hàm

    :param x: mô tả tham số x
    :return: mô tả giá trị trả về

Trang ví dụ được tạo từ docstring trong gói Flask.

Docstring

def function(x):
    """Mô tả tổng quan về hàm

    Chi tiết bổ sung về hàm

    :param x: mô tả tham số x
    :return: mô tả giá trị trả về

    >>> # Ví dụ sử dụng hàm
    Kết quả mong đợi của ví dụ
    """
    # function code

Ví dụ docstring

def square(x):
    """Bình phương số x

    :param x: số cần bình phương
    :return: x bình phương

    >>> square(2)
    4
    """
    # `x * x` nhanh hơn `x ** 2`
    # tham khảo: https://stackoverflow.com/a/29055266/5731525
    return x * x

Kết quả docstring mẫu

help(square)

square(x)
    Bình phương số x

    :param x: số cần bình phương
    :return: x bình phương

    >>> square(2)
    4

Vamos praticar!

Nguyên tắc Kỹ thuật Phần mềm với Python