Python в ArcGIS. Комментирование и документирование строк. 24

     Важная часть написание кода это создание комментариев и строк документации.

    Создание комментариев осуществляется с помощью символа #, весь текст на строке после данного символа игнорируется интерпретатором: 

"""

# Calculate average mean

list_1 = [10, 20, 30]

print sum(list_1)*len(list_1)**-1

"""

    Создание строк документации сильно выручает, когда возвращаешься к давно созданному, когда передаёшь скрипт коллеге, когда просят создать описание для программ и др. Документирование выглядит следующим образом:

"""

# -*- coding:utf-8 -*-

def none_list(n):

    """

    n - any int number, n have to be > 0

    Возвращает список длиной n, в котором все элементам присвоено None.

>>> none_list(3)

[None, None, None]

>>> [none_list(n) for n in range(4)]

[[], [None], [None, None], [None, None, None]]

    >>> none_list(-1)

    Traceback (most recent call last):

      ...

    ValueError: n must be >= 0

    >>> none_list(5.3)

    Traceback (most recent call last):

      ...

    ValueError: n must be exact integer

"""

    if not n >= 0:

        raise ValueError("n must be >= 0")

    if isinstance(n, int):

        result = [None for i in range(n)]

    else:

        raise ValueError("n must be integer")

    return result

"""

    В интерпретаторе выглядит следующим образом:

    Обратите внимание на подсказку при использовании функции, всплывает пояснение насчёт параметров функции.

    Также в любой момент можно вызвать и ознакомиться со строками документации для некоторой функции/класс/модуля: