Программирование и научные вычисления на языке Python/§4: различия между версиями
Содержимое удалено Содержимое добавлено
LeoMat (обсуждение | вклад) Нет описания правки |
LeoMat (обсуждение | вклад) Нет описания правки |
||
Строка 469:
В последнем варианте показано, что ''keyword '' аргументы могут рассматриваться как ''positional'', то есть естественно использовать их и без обозначения имен, но помня их очередность при определении функции.
==Doc strings==
В Python имеется договоренность о том, что строки документации (doc strings) вставляются сразу после заголовка функции. Doc strings содержат краткое описание цели функции и объясняют смысл аргументов и возвращаемых значений. Doc strings заключаются в тройные кавычки """, которые позволяют разбивать текст между ними в несколько строк. Вот два примера использования строк документации в функциях, короткий и длинный:
<source lang="python">
def C2F(C):
"""Convert Celsius degrees (C) to Fahrenheit."""
return (9.0/5)*C + 32
def line(x0, y0, x1, y1):
"""
Compute the coefficients a and b in the mathematical expression for a straight line y = a*x + b that goes through two points (x0, y0) and (x1, y1).
x0, y0: a point on the line (floats).
x1, y1: another point on the line (floats).
return: coefficients a, b (floats) for the line (y=a*x+b).
"""
a = (y1 - y0)/float(x1 - x0)
b = y0 - a*x0
return a, b
</source>
| |||