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

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

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

10 ответов

16 просмотров

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Всем привет, написал код ниже, но он выдает сегфолт, в чем причина? #include <stdio.h> #include <stdlib.h> #include <string.h> struct product { char *name; float price; };...
buzz базз
32
Хотел бы спросить у знающих, правильную ли я выбрал книгу для начала изучения ассемблера Юрова В.И ? Или есть более лучшие книги для начала обучения?
Botsman
25
Книга Юрова В.И пойдёт для обучения?
Botsman
24
$params = [ 'formid' => 'feedbackForm', 'formTpl' => '@CODE: <form class="form-validate" data-id="ajax_form"> <fieldset class="margin-bottom-md"> ...
Pathologic
1
> Примечательно, что новый владелец удаляет из GitHub любые жалобы, указывающие на подозрительную активность или смену владельца, и, видимо, рассчитывает на то, что пользовате...
Alex Sherbakov
1
Подскажите пожалуйста, а я могу вот такую штуку использовать? rpc, только реализованное в реббите https://www.rabbitmq.com/tutorials/tutorial-six-php ( или https://habr.com/ru...
Artyom
11
а мы ещё не созрели до того, чтобы создать отдельный чатик про настройку редакторов?
Cheese Syrowiecki
16
И ещё вопрос: можно ли типа как на дос как-то запариться и с помощью прерываний выводить текст, вместо функции printf ?
НѣкъиⰘижєжєиꙁъвьсєсвѣтьноѣсѣтиѥсть•
34
Всем привет! У меня почему-то по-разному отображается TListView в Debug и Release режимах (FireMonkey)! При запуске под Win приложения TListView заливается программо. в Debug ...
Александр COM
8
Ладно, ещё тупого спрошу. Код должен банально вывести значение регистра на консоль, на деле же не выводя ничего, просто оставляя нерабочую консоль (открыта, ничего не написан...
НѣкъиⰘижєжєиꙁъвьсєсвѣтьноѣсѣтиѥсть•
25
Карта сайта