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

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

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

12 ответов

24 просмотра

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

а через ESC-код ?
Alexey Kulakov
29
30500 за редактор? )
Владимир
47
Чёт не понял, я ж правильной функцией воспользовался чтобы вывести отладочную информацию? но что-то она не ловится
notme
18
У меня есть функция где происходит это: write_bit(buffer, 1); write_bit(buffer, 0); write_bit(buffer, 1); write_bit(buffer, 1); write_bit(buffer, 1); w...
~
13
Недавно Google Project Zero нашёл багу в SQLite с помощью LLM, о чём достаточно было шумно в определённых интернетах, которые сопровождались рассказами, что скоро всех "ибешни...
Alex Sherbakov
5
в JclConsole объявлено так: function CtrlHandler(CtrlType: DWORD): BOOL; stdcall; - где ваше объявление с stdcall? у вас на картинке нет stdcall
Karagy
8
Как передать управляющий символ в открытую через CreateProcess консоль? Собсна, есть процедура: procedure TRedirectThread.WriteData(Data: OEMString); var Written: Cardinal;...
Serjone
6
Ребят в СИ можно реализовать ООП?
Николай
33
Вот еще странный косяк, подскажите как бороться. Я git clone сделал себе всего embassy и примеры там запускаю. Всё хорошо. Но вот решил в cargo.toml зависимости не как в приме...
Lukutin R2AJP
2
program test; {$mode delphi} procedure proc(v: int32); overload; begin end; procedure proc(v: int64); overload; begin end; var x: uint64; begin proc(x); end. Уж не знаю...
notme
6
Карта сайта