Добавляют ли комментарии Coldfusion накладные расходы?

Question

Я знаю, что это довольно начальный вопрос, но обрабатываются ли комментарии Coldfusion сервером? Они добавляют накладные расходы на приложение?

Я спрашиваю, потому что некоторые ленивые программисты и плохая практика привели к тому, что в нашей компании просто комментируют код, который они больше не используют. До того, как мы получили SVN, это имело смысл, поскольку у нас была только рабочая копия, но теперь, несмотря на то, что у нас есть svn, люди продолжают просто комментировать код.

Так это добавляет накладные расходы? Есть ли другие проблемы, которые это может вызвать?

Answer 1

Нет. Комментарии в исходном коде ColdFusion (CFML) не добавляют никаких накладных расходов. Все комментарии практически во всех языках программирования игнорируются при компиляции.

CFML компилируется непосредственно в байт-код Java. Этот байт-код может быть декомпилирован для просмотра исходного кода Java, но вы никогда не сможете декомпилировать его в исходный CFML и никогда не увидите никаких комментариев, если они не добавлены декомпилятором.

Единственное, что делают комментарии, это добавляют к числу строк вашего исходного исходного кода CFML.

Если у вас есть закомментированный код в ваших файлах, он добавится к «запаху кода», и их следует удалить, поскольку оригинальный код всегда будет существовать в вашей системе контроля версий (просто убедитесь, что вы на самом деле используя контроль версий).

Answer 2

Есть ли другие проблемы, которые это может вызвать?

Да. Это может определенно вызвать путаницу, если более поздние программисты приходят и смотрят на код, так как программисты редко объясняют , почему они это комментируют. И на первый взгляд не всегда ясно, был ли код закомментирован и заменен другим кодом, или был удален определенный шаг или действие. По крайней мере, прокомментированный код всегда должен начинаться с чего-то вроде:

<!--- Disabled until we can figure out why it sometimes 
      deletes all tables from the database

<cfset ...
--->

или

<!--- Removed (temporarily?) because Bob said so (see Ticket #AZ345

<cfset ...
--->

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