Style Guide for Python Code: Documentation Strings
| Английский оригинал | Перевод на русский | |
|---|---|---|
Сожалеем, но текст оригинала доступен только зарегистрированным пользователям. |
Соглашение о написании хороших строк документации (docstrings) увековечены в PEP 257 wuffur 24.03.09 в 07:52 |
|
|
Пишете docstrings для public модулей, функций, классов и методов. wuffur 24.03.09 в 07:55 |
||
|
Docstrings не обязательны для не public методов, но вам следует ставить комменатрии, которые описывают, что метод выполняет. wuffur 24.03.09 в 17:44 |
||
|
Комментарий должен появиться после строки c определенем "def". wuffur 24.03.09 в 17:45 |
||
|
PEP 257 описывает хорошие соглашения по docstrings. wuffur 24.03.09 в 17:46 |
||
|
Имейте в виду, что наиболее важно, чтобы """, которая закрывает многострочные docstrings, должны быть на отдельной строке, и желательно после них была пустая линия, как здесь:
wuffur 24.03.09 в 17:49 |
||
|
Для однострочных docstrings, ничего что закрывающие """ находятся на одной линии. wuffur 24.03.09 в 17:58 |