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

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

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

10 ответов

27 просмотров

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

30500 за редактор? )
Владимир
47
а через ESC-код ?
Alexey Kulakov
29
Чёт не понял, я ж правильной функцией воспользовался чтобы вывести отладочную информацию? но что-то она не ловится
notme
18
Добрый день! Скажите пожалуйста, а какие программы вы бы рекомендовали написать для того, чтобы научиться управлять памятью? Можно написать динамический массив, можно связный ...
Филипп
7
У меня есть функция где происходит это: write_bit(buffer, 1); write_bit(buffer, 0); write_bit(buffer, 1); write_bit(buffer, 1); write_bit(buffer, 1); w...
~
14
Недавно Google Project Zero нашёл багу в SQLite с помощью LLM, о чём достаточно было шумно в определённых интернетах, которые сопровождались рассказами, что скоро всех "ибешни...
Alex Sherbakov
5
Ребят в СИ можно реализовать ООП?
Николай
33
Как передать управляющий символ в открытую через CreateProcess консоль? Собсна, есть процедура: procedure TRedirectThread.WriteData(Data: OEMString); var Written: Cardinal;...
Serjone
6
https://github.com/erlang/otp/blob/OTP-27.1/lib/kernel/src/logger_h_common.erl#L174 https://github.com/erlang/otp/blob/OTP-27.1/lib/kernel/src/logger_olp.erl#L76 15 лет назад...
Maksim Lapshin
20
Всем привет! Имеется функция: function IsValidChar(ch: UTF8Char): Boolean; var i: Integer; ValidChars: AnsiString; begin ValidChars := 'abcdefghijklmnopqrstuvwxyzABCDE...
Евгений
44
Карта сайта