как зарегистрировать пакет Python
Я знаю то, что является стандартным способом зарегистрировать функции, классы и модули, но как делают я документирую пакеты - делают я вставил docstring __init__.py, или что-то еще?
3 ответа
Да, как и для комментария функции или класса, первый элемент в файле __init__.py должен быть строкой комментария:
"""
This is the xyz package.
"""
Теперь, если вы импортируете пакет и используете help(package), вы увидите вашу docstring. См. подробнее здесь: http://www.python.org/dev/peps/pep-0257/
См. PEP257
Пакет может быть документирован в docstring модуля файла __ init __.py в каталоге пакета.
Документирование - хорошая идея, если вы этого не сделаете. t задокументировать что-то очевидное в вашем коде
Постарайтесь понять, что большинство людей, читающих ваш исходный код, понимают python, поэтому комментировать или документировать такие строки бессмысленно:
a = 1 #this assigns 1 to a
Но комментирование или документирование довольно сложной функции или класса - хорошая идея .
Общее практическое правило: представьте, что следующий человек, который будет работать над вашим кодом, - это маньяк с топором, и он знает, где вы живете.
Таким образом, вы всегда будете оставлять «полезные» комментарии / документы