From 6368dcf7f1cbe3093b13ee3446f1d77dcff18e3f Mon Sep 17 00:00:00 2001 From: Dmitry Semigradsky Date: Fri, 22 Jul 2022 10:56:32 +0300 Subject: [PATCH] Update ru/thing_25 Fix #31 --- ru/thing_25/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ru/thing_25/README.md b/ru/thing_25/README.md index cc03ae41..52334569 100644 --- a/ru/thing_25/README.md +++ b/ru/thing_25/README.md @@ -1,7 +1,7 @@ # Комментируйте лишь то, что не ясно из кода (В оригинале - Comment Only What the Code Cannot Say) -Различий между теорией и практикой гораздо больше на практике, чем в терории – это как нельзя более актуально применительно к комментариям. В теории идея комментариев заключается в том, чтобы «объяснить то, что происходит, дать больше деталей». Чем же желание объяснить может быть плохим? Однако на практике комментарии часто начинают приносить вред, а не пользу. Как и в любом другом деле, написание хороших комментариев – это умение. И значительная часть умения состоит в том, чтобы знать, когда их вообще писать не надо. +Различий между теорией и практикой гораздо больше на практике, чем в теории – это как нельзя более актуально применительно к комментариям. В теории идея комментариев заключается в том, чтобы «объяснить то, что происходит, дать больше деталей». Чем же желание объяснить может быть плохим? Однако на практике комментарии часто начинают приносить вред, а не пользу. Как и в любом другом деле, написание хороших комментариев – это умение. И значительная часть умения состоит в том, чтобы знать, когда их вообще писать не надо. Если в коде есть ошибки, то компилятор, интерпретатор или другой подобный инструмент это сразу же обнаружат. Если ошибки есть на функциональном уровне, то ревью, статический анализ, тестирование и эксплуатация рано или поздно будут приводить к их обнаружению и устранению. А комментарии? В книге *“The Elements of Programming Style”* Kernighan и Plauger заметили, что «комментарий имеет нулевую или отрицательную ценность, если он неправильный». И такие комментарии часто сильно засоряют исходный код, оставаясь там долгое время, в отличие от ошибок в самом коде. При этом такие комментарии постоянно приводят к отвлечению внимания или даже к дезориентации того, кто этот код сопровождает. @@ -13,4 +13,4 @@ Комментируйте лишь то, что код не может сообщить в принципе, а не то, что он не сообщает сейчас. -Автор оригинала - [Kevlin Henney](http://programmer.97things.oreilly.com/wiki/index.php/Kevlin_Henney) \ No newline at end of file +Автор оригинала - [Kevlin Henney](http://programmer.97things.oreilly.com/wiki/index.php/Kevlin_Henney)