Лучше писать хорошие названия которые будут говорить сами за себя
Анатолий Вассерман комментировал каждую строчку кода на ассемблере, когда работал программистом на заводе холодильников
Ну тут просто понятно что функция Init нужна для инициализации, а не для закрытия программы Вот стоит ли ее комментировать?
Вот пример: сделать typedef bool InitResult_t;
Код должен быть самодокументирующийся. Комментарии по сути это костыль. Комментарий описывающий неочевидное поведение это отличный повод порефакторить. Но реальность немного жёстче и от них конечно всё равно на 100% не избавиться. Однако это не значит что не стоит пытаться.
Только стоит ещё уточнить что для публичных интерфейсов они в любом случае нужны, потому что в имя метода впихнуть всё что о нем надо знать это уже чересчур редкий случай.
не просто в название, в сигнатуру. вот в сях можно было сделать так: enum ButtonState { bs_Pressed, bs_Released } button_state(struct button *this); и всё предельно ясно безо всяких комментов
Обсуждают сегодня