В Python есть несколько стандартных способов документирования кода: - **Docstrings** — строки документации в тройных кавычках, доступные через `__doc__`. Поддерживают форматы Google, NumPy, reST. ``` def add(a, b): """Складывает два числа. Args: a (int): Первое число. b (int): Второе число. Returns: int: Сумма a и b. """ return a + b ``` - **Комментарии** (`#`) — для пояснения сложных мест, но не заменяют docstrings. - **Type Hints** (PEP 484) — аннотации типов для аргументов и возвращаемых значений. ``` def greet(name: str) -> str: return f"Hello, {name}" ``` - **Sphinx** — генератор документации из docstrings, поддерживает HTML/PDF. - **pydoc** — встроенный модуль для просмотра docstrings (`python -m pydoc модуль`). Лучшие практики: - Пишите docstrings для всех публичных модулей, функций, классов. - Используйте единый стиль (например, Google-style). - Обновляйте документацию при изменении кода.