джанго-проекте? Если например есть функция "get_articles_list", нужно ли писать, что функция возвращает список статей или это уже излишество? Есть какое-то руководство ЧТО и КАК рекомендуется все это делать?
Если вы пишите для себя, то комментируйте только то, что вам не понятно
А если предполагается, что мой проект могут смотреть другие люди, или даже работать над ним вместе со мной? Как происходит документирование проекта в компании с большой командой, например?
не подскажу, тут помощь более компетентных людей просите
ну вот и спрашиваю у всех небезразличных и знающих
не путаешь докстринги и комментарии?
да, именно докстринги. Немного ошибся
Докстринги надо
Переспрошу: даже если все очевидно, исходя из названия функции/класса?
со временем может поменяться внутренняя логика, которая должна быть описана в докстринге, так что да
хорошо, большое спасибо за ответ
Обсуждают сегодня