文件字串

Intermediate Python for Developers

Jasmin Ludolf

Senior Data Science Content Developer

文件字串

描述函式的文字區塊
協助你了解如何使用函式

Help on built-in function round in module builtins:

round(number, ndigits=None)

  Round a number to a given precision in decimal digits.

  The return value is an integer if ndigits is omitted or None. Otherwise 
  the return value has the same type as the number. ndigits may be negative.

取得文件字串

# Access information, including the docstring
print(help(round))

Help on built-in function round in module builtins:

round(number, ndigits=None)
    Round a number to a given precision in decimal digits.

    The return value is an integer if ndigits is omitted or None.  Otherwise
    the return value has the same type as the number.  ndigits may be negative.

None

取得文件字串

# Access only the docstring
print(round

取得文件字串

# Access only the docstring
print(round.

取得文件字串

# Access only the docstring
print(round.__

取得文件字串

# Access only the docstring
print(round.__doc

取得文件字串

# Access only the docstring
print(round.__doc__)

Round a number to a given precision in decimal digits.

The return value is an integer if ndigits is omitted or None.  Otherwise
the return value has the same type as the number.  ndigits may be negative.

.__doc__: 「dunder-doc」屬性

建立文件字串

def average(values):

    # One-line docstring
    """計算序列的平均數，並四捨五入到小數點後兩位。"""

    average_value = sum(values) / len(values)
    rounded_average = round(average_value, 2)
    return rounded_average

存取文件字串

# Access our docstring
print(average.__doc__)

Find the mean in a sequence of values and round to two decimal places.

更新文件字串

# Update a function's docstring
average.__doc__ = "Calculate the mean of values in a data structure, rounding the results to 2 digits."


print(help(average))

Help on function average in module __main__:

average(values)
    Calculate the mean of values in a data structure, rounding the results to 2 digits.

多行文件字串

def average(values):
    """
    Find the mean in a sequence of values and round to two decimal places.






    """

    average_value = sum(values) / len(values)
    rounded_average = round(average_value, 2)
    return rounded_average

多行文件字串

def average(values):
    """
    Find the mean in a sequence of values and round to two decimal places.

    Args:




    """

    average_value = sum(values) / len(values)
    rounded_average = round(average_value, 2)
    return rounded_average

多行文件字串

def average(values):
    """
    Find the mean in a sequence of values and round to two decimal places.

    Args:
        values (list): A list of numeric values.



    """

    average_value = sum(values) / len(values)
    rounded_average = round(average_value, 2)
    return rounded_average

多行文件字串

def average(values):
    """
    Find the mean in a sequence of values and round to two decimal places.

    Args:
        values (list): A list of numeric values.

    Returns:
        rounded_average (float): The mean of values, rounded to two decimal places.
    """

    average_value = sum(values) / len(values)
    rounded_average = round(average_value, 2)
    return rounded_average

存取文件字串

# Help
print(help(average))

Help on function average in module __main__:

average(values)
    Find the mean in a sequence of values and round to two decimal places.

        Args:
            values (list): A list of numeric values.

        Returns:
            rounded_average (float): The mean of values, rounded to two decimal places.

一起來練習吧！

Intermediate Python for Developers