170 похожих чатов

Здравствуйте, вопрос: все ли функции и классы нужно документировать в

джанго-проекте? Если например есть функция "get_articles_list", нужно ли писать, что функция возвращает список статей или это уже излишество? Есть какое-то руководство ЧТО и КАК рекомендуется все это делать?

10 ответов

14 просмотров

Если вы пишите для себя, то комментируйте только то, что вам не понятно

Ярослав- Автор вопроса

А если предполагается, что мой проект могут смотреть другие люди, или даже работать над ним вместе со мной? Как происходит документирование проекта в компании с большой командой, например?

не подскажу, тут помощь более компетентных людей просите

Ярослав- Автор вопроса

ну вот и спрашиваю у всех небезразличных и знающих

не путаешь докстринги и комментарии?

Ярослав- Автор вопроса

да, именно докстринги. Немного ошибся

Докстринги надо

Ярослав- Автор вопроса

Переспрошу: даже если все очевидно, исходя из названия функции/класса?

со временем может поменяться внутренняя логика, которая должна быть описана в докстринге, так что да

Ярослав- Автор вопроса

хорошо, большое спасибо за ответ

Похожие вопросы

Обсуждают сегодня

коллеги, добрый вечер! А никто не знает как модальная форма может себя закрыть? Ну допустим модальная форма определила, что смысла ей работать нет и хочет вернуть modalResult...
Михаил
83
Hi Everyone! To all Are you Looking for Interview Support at the Lowest Price? Look no further! Then contact us We offer Interview Support for a low cost variety of technol...
Rambabu Nallamilli
3
верно что я могу удалить эти addq и subq т.к. со стеком никакого взаимодействия нет (исключая call)?
Michael
16
Добрый день Хочу начать обучение языку, не являюсь представителем it, буду благодарна за помощь, совсем пока не понимаю ничего) Подскажите, пожалуйста, где можно начать первы...
Sara Lala
28
А если изначально бот работал так : есть сайт онлайн школы. У каждого ученика свой кабинет. Где он авторизуется по своим данным. И уже в кабинете, на самом сайте делает оплату...
Денис 💡 Фрилансер
13
средствами IBX как-то можно выполнить запрос insert ... returning?
Igor
31
А что ты вообще делаешь ?
Yesgoter
13
Hi there everyone Is there anyone who have not started hamster bot yet? I need only one, I'll be glad if you do this for me DM if you haven't yet
Mehrshad
53
На работе пишем распределенное приложение, у которого сотни, если не тысячи настроек. Конфиги написаны на xml, расположены на разных хостах и должны быть согласованы друг с др...
Aleksandr Druzhinin
5
Всем привет 🙂 Какая-то непонятная проблема у меня с видео, раньше такого не было. Загружаю видео с гугл диска именно в видео mp4 и меняю ссылку как положено вот она: https://d...
Ксюша|Верстка на Тильде|Дизайн 🦥
6
Карта сайта