В проектах ПЛК часто говорят: "Чем больше комментариев, тем лучше программа!" Это утверждение кажется разумным, ведь ясные комментарии помогают инженерам легче понять логику кода. Однако, действительно ли это так? Определяет ли количество комментариев качество программы?
В процессе разработки программы мы часто сталкиваемся с явлением, когда некоторые инженеры используют комментарии как выход для выражения эмоций, добавляя в них даже "специальный язык". Это поднимает интересный вопрос: влияют ли комментарии с эмоциональной лексикой или даже нецензурными словами на качество программы?
«Темпераментные» иностранные комментарии ПЛК
Некоторое время назад я увидел статью на одной из социальных платформ, которая исследовала это явление. Немецкий инженер-автоматчик специально изучил этот вопрос. Он собрал 100 проектов ПЛК с нецензурной лексикой и 200 проектов без нее, а затем проанализировал их соответствие стандартам программирования с помощью программного обеспечения, оценивая каждый проект по отдельности.
Используя центральную предельную теорему статистики, после серии сложных расчетов он пришел к удивительному выводу: качество программ ПЛК с нецензурной лексикой было значительно выше, чем у тех, которые не содержали ругательств!
Может ли нецензурная лексика улучшить качество программы?
Услышав этот вывод, вы, возможно, удивитесь. Инженер объяснил, что нецензурная лексика представляет собой эмоциональное освобождение инженеров ПЛК, когда они сталкиваются с сложной логикой. При написании программ для ПЛК сложность логического управления часто сводит людей с ума. Несколько крепких слов в нужный момент могут эффективно снять стресс, позволив инженерам сосредоточиться на кодировании, что улучшает качество программы.
Это кажется логичным, но не стоит ошибочно полагать, что если вы будете писать больше ругательств в комментариях к коду, то качество программы автоматически улучшится. Это было бы заблуждением! На самом деле ключ к улучшению качества программы заключается в высвобождении эмоций и улучшении концентрации, а нецензурные выражения — лишь один из способов, который выбирают некоторые инженеры.
«Тонкое выражение» китайских инженеров
В отличие от иностранных коллег, которые склонны быть более прямолинейными, китайские инженеры ПЛК обычно не «показывают эмоции» в комментариях к программам. Если это возможно, комментарии часто опускаются, и порой можно не найти ни одной строки комментариев. Это «тонкое выражение» может казаться, что проект выглядит аккуратно и упорядоченно на поверхности, но оно увеличивает сложность последующего обслуживания. В конце концов, поддержка программы обычно не осуществляется ее первоначальным разработчиком, и код без комментариев — это как блуждание в темноте.
Некоторые могут сказать: «Без комментариев? Я сам понимаю свою программу, этого достаточно!» Но проблема в том, что когда ваш код передается другим коллегам или внешним командам, проект без комментариев становится как скрытая ловушка. Особенно когда программа сложная, отсутствие комментариев эквивалентно отсутствию карты, и последующие инженеры могут потратить в несколько раз больше времени на интерпретацию вашей логики.
Искусство комментариев ПЛК
Итак, как правильно добавлять комментарии? Во-первых, «чем больше комментариев, тем лучше» — это не всегда верно. Чрезмерные комментарии часто приводят к избыточности, делая код запутанным. Идеальные комментарии должны быть лаконичными и по существу, помогая следующему читателю кода быстро понять каждую часть логики.
Во-вторых, содержание комментариев имеет важное значение. Не просто механически объясняйте, что делает код, но более важно объяснять, почему это сделано именно так. Например, часть логики ПЛК предназначена для выполнения специфических требований процесса или для специальной обработки сложного устройства. Такие комментарии могут не только помочь другим понять ваш ход мысли, но и позволят вам быстро прояснить логику при повторном просмотре.
В реальных проектах, если вы видите комментарий с «эмоциональной» лексикой или даже нецензурными словами, будьте особенно осторожны. Такие комментарии часто означают, что инженер столкнулся с сложной логикой или проблемой, и если не быть внимательным, можно «наступить» на эту «скрытую бомбу». Поэтому при встрече с такими комментариями лучше не трогать эту часть кода, если вы не полностью понимаете ее смысл и логику, стоящую за этим.
Комментарии действительно являются частью качества программ ПЛК, но они не решающий фактор. Разумные комментарии могут улучшить поддерживаемость и читаемость кода, но количество комментариев не определяет качество программы. Важен именно их качественный состав — они должны помогать инженерам понять логику кода, особенно когда приходится работать с комплексными проектами.
В следующий раз, когда будете писать программу ПЛК, не забудьте выделить время для написания ясных и полезных комментариев — это может сэкономить много времени на последующем обслуживании. А что касается нецензурных слов? Лучше сохранять профессионализм в коде.
中文
Global
