Często widziałem takie komentarze:
function foo() {
...
} // foo
while (...) {
...
} // while
if (...) {
...
} // if
a czasem nawet o ile
if (condition) {
...
} // if (condition)
Nigdy nie zrozumiałem tej praktyki i dlatego nigdy jej nie zastosowałem. Jeśli twój kod jest tak długi, że musisz wiedzieć, co to }
jest za zakończenie, być może powinieneś rozważyć podzielenie go na osobne funkcje. Ponadto większość narzędzi dla programistów jest w stanie przeskoczyć do pasującego wspornika. I w końcu ostatnie jest dla mnie wyraźne naruszenie zasady SUCHEJ; jeśli zmienisz warunek, musisz pamiętać również o zmianie komentarza (w przeciwnym razie może to być nieporządne dla opiekuna, a nawet dla ciebie).
Dlaczego ludzie z tego korzystają? Czy powinniśmy go użyć, czy jest to zła praktyka?
if ... then ... end if;
while ... loop ... end loop;
procedure Foo is ... end Foo;
. Uważam, że pomaga to w czytelności (i jest sprawdzane przez kompilator, których komentarzy nie ma).
if(condition): ... else: ... endif;