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

Хорошая документация важна на самом деле, включая комментарии. Ингода, когда

смотрю на свой код трех-четырех годичной давности возникает то самое чувство: «Что за древнее писание?»

12 ответов

26 просмотров

Я придерживаюсь мнения, что писать код надо так, чтобы комментариев было как можно меньше Не считая документацию

Danya🔥
Я придерживаюсь мнения, что писать код надо так, ч...

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

Till Schneider
Иногда может быть так: ты думаешь, что это очевидн...

По идее такое должно на кодревью выявляться

Danya🔥
По идее такое должно на кодревью выявляться

А потом смена команды))) и новая команда без контекста не понимает)))

Mikhail-Kalugin Автор вопроса
Danya🔥
По идее такое должно на кодревью выявляться

И документация - простое описание вида: кто и когда это сделал, что оно делает, что на входе, что на выходе хорошо помогает, думаю даже при смене команды.

Mikhail-Kalugin Автор вопроса
Mikhail Kalugin
И документация - простое описание вида: кто и когд...

Против документации ничего не имею против Я против только избыточных комментариев

Mikhail Kalugin
doxygen вам в помощь :)

Так да, о том и речь, что лучше оставить комментарий, чтоб не возникало потом лишних вопросов

Mikhail-Kalugin Автор вопроса
Danya🔥
Против документации ничего не имею против Я против...

Согласен - комментарии в каждой второй строке - зло.

Mikhail Kalugin
doxygen вам в помощь :)

Была запланирована ещё и вторая часть статьи, где про "не бесполезную документацию"

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

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

Господа, а что сейчас вообще с рынком труда на делфи происходит? Какова ситуация?
Rꙮman Yankꙮvsky
29
А вообще, что может смущать в самой Julia - бы сказал, что нет единого стандартного подхода по многим моментам, поэтому многое выглядит как "хаки" и произвол. Короче говоря, с...
Viktor G.
2
30500 за редактор? )
Владимир
47
а через ESC-код ?
Alexey Kulakov
29
Гайс, вопрос для разносторонее развитых: читаю стрим с юарта, нада выделять с него фреймы с определенной структурой, если ли чо готовое, или долбаться с ринг буффером? нада у...
Vitaly
9
Чёт не понял, я ж правильной функцией воспользовался чтобы вывести отладочную информацию? но что-то она не ловится
notme
18
У меня есть функция где происходит это: write_bit(buffer, 1); write_bit(buffer, 0); write_bit(buffer, 1); write_bit(buffer, 1); write_bit(buffer, 1); w...
~
14
Добрый день! Скажите пожалуйста, а какие программы вы бы рекомендовали написать для того, чтобы научиться управлять памятью? Можно написать динамический массив, можно связный ...
Филипп
7
Недавно Google Project Zero нашёл багу в SQLite с помощью LLM, о чём достаточно было шумно в определённых интернетах, которые сопровождались рассказами, что скоро всех "ибешни...
Alex Sherbakov
5
длина пакета фиксированная, или меняется?
Okhsunrog
7
Карта сайта