Я часто бачив, як використовуються такі коментарі:
function foo() {
...
} // foo
while (...) {
...
} // while
if (...) {
...
} // if
а іноді навіть наскільки це можливо
if (condition) {
...
} // if (condition)
Я ніколи не розумів цієї практики і, отже, ніколи не застосовував її. Якщо ваш код настільки довгий, що вам потрібно знати, що таке закінчення }
, можливо, вам слід розглянути питання про його поділ на окремі функції. Крім того, більшість інструментів розробників здатні перейти на відповідну дужку. І нарешті, останнє - явне порушення принципу DRY; якщо ви зміните умову, вам доведеться пам’ятати, щоб змінити коментар (інакше це може заплутатися для обслуговуючого персоналу або навіть для вас).
То чому люди використовують це? Чи повинні ми його використовувати, чи це погана практика?
if ... then ... end if;
while ... loop ... end loop;
procedure Foo is ... end Foo;
. Я вважаю, що це допомагає розбірливості (і це перевіряє компілятор, котрий коментарі ні).
if(condition): ... else: ... endif;