Как правильно комментировать код

@kent · Регистрация: 19.02.2012

Author24 — интернет-сервис помощи студентам

Всем привет.
Объясните, пожалуйста, как и что комментировать в коде, чтобы исходники были предельно ясными?

@Денис Н. · 01.08.2012, 16:51

Чтобы исходники были предельно ясными, нужно научиться писать самодокоментируемый код, то есть такой, который не нуждается ни в одном комментарии, ибо там и так всё будет как на ладони

@Grossmeister · 02.08.2012, 09:30

Сообщение от Денис Н.

то есть такой, который не нуждается ни в одном комментарии, ибо там и так всё будет как на ладони

Это не всегда возможно. Встречаются ньюансы (касающиеся предметной области, а не хитрого приема программирования), которые неочевидны, исходя из самого хорошего кода. При этом их сам можешь забыть через некоторое время (если придется модифицировать код), не говоря уж о непонятках для другого (если ему придется модифицировать). Вот такие места обязательно нужно комментировать.
Этим можно значительно съэкономить время при сопровождении программы.

@CheshireCat · 02.08.2012, 09:42

Правильный комментарий объясняет не что делает код (что делает код - это как раз очевидно из самого кода), а почему он это делает - вот это может быть совсем не очевидно. А также какие-то хитрые алгоритмические приемы-выкрутасы, и т.п. - то, что в после написания кода осталось "в голове" автора кода и может когда-либо понадобиться другим программистам, которым придется сопровождать этот код, - а телепатии они, естественно, не обучены :-) То есть это по сути проектная документация, сохраненная в самом исходнике. Важно помнить: код пишется один раз, а читается - сотни, а может быть и тысячи раз.....

@kent Нуб со стажем 36 / 34 / 10 Регистрация: 19.02.2012 Сообщений: 118
		1
	Как правильно комментировать код 01.08.2012, 16:44. Показов 4743. Ответов 3 Метки нет (Все метки) Всем привет. Объясните, пожалуйста, как и что комментировать в коде, чтобы исходники были предельно ясными? 0

@Денис Н. 463 / 463 / 23 Регистрация: 17.08.2011 Сообщений: 1,488
	01.08.2012, 16:51	2
	Чтобы исходники были предельно ясными, нужно научиться писать самодокоментируемый код, то есть такой, который не нуждается ни в одном комментарии, ибо там и так всё будет как на ладони 0

@Grossmeister 4217 / 3058 / 583 Регистрация: 21.01.2011 Сообщений: 13,205
	02.08.2012, 09:30	3
	Сообщение от Денис Н. то есть такой, который не нуждается ни в одном комментарии, ибо там и так всё будет как на ладони Это не всегда возможно. Встречаются ньюансы (касающиеся предметной области, а не хитрого приема программирования), которые неочевидны, исходя из самого хорошего кода. При этом их сам можешь забыть через некоторое время (если придется модифицировать код), не говоря уж о непонятках для другого (если ему придется модифицировать). Вот такие места обязательно нужно комментировать. Этим можно значительно съэкономить время при сопровождении программы. 0

@CheshireCat 2924 / 1274 / 114 Регистрация: 27.05.2008 Сообщений: 3,465
	02.08.2012, 09:42	4
	Правильный комментарий объясняет не что делает код (что делает код - это как раз очевидно из самого кода), а почему он это делает - вот это может быть совсем не очевидно. А также какие-то хитрые алгоритмические приемы-выкрутасы, и т.п. - то, что в после написания кода осталось "в голове" автора кода и может когда-либо понадобиться другим программистам, которым придется сопровождать этот код, - а телепатии они, естественно, не обучены :-) То есть это по сути проектная документация, сохраненная в самом исходнике. Важно помнить: код пишется один раз, а читается - сотни, а может быть и тысячи раз..... 2