Всем здравствуйте. Банальный вопрос: стоит ли все досконально комментировать: за что

отвечает функция, что возвращает и так далее?
К примеру функция init понятно для чего нужна

7 ответов

29 просмотров

Лучше писать хорошие названия которые будут говорить сами за себя

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

Nikita-Gordeev Автор вопроса
Anatoliy Tomilov [Russia]
Анатолий Вассерман комментировал каждую строчку ко...

Ну тут просто понятно что функция Init нужна для инициализации, а не для закрытия программы Вот стоит ли ее комментировать?

Вот пример: сделать typedef bool InitResult_t;

Код должен быть самодокументирующийся. Комментарии по сути это костыль. Комментарий описывающий неочевидное поведение это отличный повод порефакторить. Но реальность немного жёстче и от них конечно всё равно на 100% не избавиться. Однако это не значит что не стоит пытаться.

Только стоит ещё уточнить что для публичных интерфейсов они в любом случае нужны, потому что в имя метода впихнуть всё что о нем надо знать это уже чересчур редкий случай.

Vladimir Shcherba
Только стоит ещё уточнить что для публичных интерф...

не просто в название, в сигнатуру. вот в сях можно было сделать так: enum ButtonState { bs_Pressed, bs_Released } button_state(struct button *this); и всё предельно ясно безо всяких комментов

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

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

Гайс, вопрос для разносторонее развитых: читаю стрим с юарта, нада выделять с него фреймы с определенной структурой, если ли чо готовое, или долбаться с ринг буффером? нада у...
Vitaly
9
Недавно Google Project Zero нашёл багу в SQLite с помощью LLM, о чём достаточно было шумно в определённых интернетах, которые сопровождались рассказами, что скоро всех "ибешни...
Alex Sherbakov
5
длина пакета фиксированная, или меняется?
Okhsunrog
7
Вот еще странный косяк, подскажите как бороться. Я git clone сделал себе всего embassy и примеры там запускаю. Всё хорошо. Но вот решил в cargo.toml зависимости не как в приме...
Lukutin R2AJP
5
А в каком формате фреймы? Сам формат сейчас придумываешь, или что-то готовое нужно распарсить?
Okhsunrog
5
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
Добрый вечер, Пока не совсем понимаю как наладить общение между телеграм ботом и ПО для работы с сим боксом. По самому боту так понял: - Нужен некий баланс, который можно поп...
Magic
6
Всем привет, нужна как никогда, нужна помощь с IO в загрузчике. Пишу в code16 после установки сегментных регистров, пишу вывод символа. Пробовал 2 варианта: # 1 mov $0x0E, %a...
Shadow Akira
14
Раз начали говорить про embassy, то присоединюсь со своими парой вопросов. 1) Есть ли сопоставимые аналоги для асинхронного кода в emdebbed? 2) Можно ли внутри задач embassy ...
NI_isx
6
сделал сайт, прикрутил в боте сайт, и виджет логина. как автоматически логинить пользователя в аккаунт(телеграм), при входе с бота?
Александра Чернивецкая
5
Карта сайта