Docstring - (сокращение от documentation string, строка документации) встроенное средство документирования модулей, функций, классов и методов. Делается очень просто - сразу после определения указывается строковое значение, которое и будет docstring'ом.

>>> def test():
...    "This is the test's docstring"
...    print "opa"

Получить доступ к docstring можно так:

>>> test.__doc__
"This is the test's docstring"

Либо так:

>>> help(test)
Help on function test in module __main__:

test()
    This is the test's docstring

Существуют инструменты, которые позволяют извлекать docstring не по одиночке, а для целого модуля/пакета. О них и пойдет речь.

Изучаем дальше:



Комментарии