документация носит больше ознакомительный характер
Где-то я уже это слышал. Только ник был другой. 
Где-то я уже это слышал. Только ник был другой. roll
Озвучьте-ка в специальном разделе.
]]>документация носит больше ознакомительный характер
Где-то я уже это слышал. Только ник был другой.
AHK не входит в сферу моих интересов: ни профессиональных, ни увлечений. Тем не менее, читая код, могу понять более-менее, что происходит с тем или иным кодом.
Ваша просьба комментировать каждую строку кода приведет 1) к дублированию кода его описанием; 2) к распуханию примеров в 2-3 раза (за счет того, что комментарии на русском будут объемнее). Комментарий нужен чтобы объяснить некоторые сложные или неочевидные моменты кода.
]]>В том то и дело, что я бы и не понял, если комментария не было. А тут на практике наглядный пример!
А на вопрос всё же не ответили, т. е. скорее всего сути кода не поняли (либо не поняли по-крайней мере до тех пор, пока не прочитали соответствующую статью в справке). А какой смысл в практике, если теория не ясна? С другой стороны, как только осознаете теорию, данный комментарий становится излишним. Вот и приходим к тому, что говорил alexii — зачем переписывать в комментариях справку?
Поэтому каждую строчку уж точно комментировать не стоит, вполне достаточно обойтись описанием алгоритма. А если что-то непонятно, или, как чаще всего бывает, автор поленился писать комментарии, всегда можно задать вопрос.
last_line := A_LoopReadLine ; По завершении цикла здесь будет содержаться последняя строка.
А как вы поняли, почему "По завершении цикла здесь будет содержаться последняя строка"?
]]>Можете привести пример кода с комментариями, которые кажутся вам достаточными?
Тема:Проверка и чтение текстового файла. Отправил: Zohann
Loop, read, C:\Log File.txt
last_line := A_LoopReadLine ; По завершении цикла здесь будет содержаться последняя строка.
If last_line = "Время действовать"
MsgBox "Время читать справку"А комментарии, описывающие особенности и тонкие моменты алгоритма и без всяких правил обычно наличествуют.
В том то и дело что нет. Чаще всего представлен только лишь код, с объяснением конечного результата. А как этого результата добились, остается за скобками. А документация, при всем моем уважении к проделанному труду, носит больше ознакомительный характер, чем нежили руководство к пользованию. Пояснения же введут ясность на практике.
]]>Я лично не вижу никакой необходимости комментировать каждое действие, ибо описание каждого действия есть в документации с поясняющими примерами. А комментарии, описывающие особенности и тонкие моменты алгоритма и без всяких правил обычно наличествуют.
Ведь, не так сложно напечатать несколько строк пояснения,
Не сложно. Но если двадцать раз в день копировать из документации в код одно и то же — это очень быстро надоест.
но зато исчезнет много лишних тем с повторяющимися вопросами.
К сожалению, не исчезнет. Проверено.
Кто-то действительно не находит, кто-то не понимает… Но большая часть банально халтурит, ленится искать или вовсе гордо бьёт себя в грудь с криком: «Не знаю, и знать не хочу! Сделайте мне это!».
]]>