Встречается на собеседованиях • сегодня

Как документировать код в Django

В Django принято документировать код с помощью docstrings в формате Google или reStructuredText (reST). Основные места для документации: модели, представления, формы, шаблонные теги и API.

Пример документации модели в стиле Google:

python
class Article(models.Model):
    """Статья блога.

    Attributes:
        title (str): Заголовок статьи, максимум 200 символов.
        content (str): Текст статьи.
        pub_date (datetime): Дата публикации.
        author (User): Автор статьи.
    """
    title = models.CharField(max_length=200)
    content = models.TextField()
    pub_date = models.DateTimeField(auto_now_add=True)
    author = models.ForeignKey(User, on_delete=models.CASCADE)
text
def __str__(self):
    """Возвращает строковое представление статьи (заголовок)."""
    return self.title
text

Для представлений (views) документируйте:
- Назначение view
- Принимаемые параметры
- Возвращаемые значения
- Возможные исключения

Для API используйте drf-yasg или drf-spectacular для автоматической генерации Swagger/OpenAPI документации.
Sophi
Софи собрала все вопросы. Тренируйся и получай
офферы быстрее!
Попробовать бесплатноArrow

Следующий вопрос

Это единственный вопрос по вашему фильтру

как отвечать на вопрос
пример собеседования
фреймворки на собеседовании
типичные вопросы junior
интервью вопросы и ответы