Комментарии
В процессе эволюции языков программирования сложилось так, что оказались жизнеспособными
два вида комментариев: длинные (с условно скобочной структурой) и короткие, занимающие конец строки.
В Си они представлены /*...*/ и //... соответственно.
В последнее время появились комментарии третьего вида: комментарии генерации документации.
Идея замечательна: прокомментировал функцию, и этим одновременно создал help для неё.
На этом, казалось бы, можно поставить точку.
Комментарии — это не та тема, которая может быть направлением прорыва в языках программирования, над чем ломают головы лучшие умы человечества.
Но не будем торопиться закрывать эту тему.
Экспериментируя с компиляцией кодов C++, мне захотелось сделать так, чтобы длинные комментарии могли бы быть вложенными.
Ведь они по сути — квази-скобки: /* и */.
Одна квази-скобка открывает комментарий, а вторая закрывает.
Это очень удобно. Допустим, имеется фрагмент программы:
текст программы
/* комментарий */
текст программы
Если мне надо для каких-то целей этот фрагмент закомментировать целиком,
сделать его нерабочим, то содержащийся внутри комментарий этому совершенно не мешает:
число открывающих скобок равно числу закрывающих.
И у нас всё хорошо.
Но от этого пришлось отказаться.
В C++ комментарии не могут быть вложенными, для совместимости со стандартом языка
следует отказаться от такой возможности.
Так почему в C++ вложенные комментарии невозможны?
Это казалось идиотизмом, которому нет разумных объяснений.
Ведь это так элементарно! Объяснение нашлось случайно.
Допустим, у нас есть такой кусок программы:
char x[] = "*/"; // строка n+1
/* комментарий */ // строка n+2
// ещё какой-то код // строка n+3
А теперь весь этот фрагмент поместим внутрь другого комментария:
/* начало комментария верхнего уровня // строка n
char x[] = "*/"; // строка n+1
/* комментарий */ // строка n+2
// ещё какой-то код // строка n+3
конец комментария верхнего уровня */ // строка n+4
При компиляции этого текста будет обнаружена ошибка.
Комментарий верхнего уровня, начинающийся в строке n, закончится не в строке n+4 и даже не в строке n+2, а в строке n+1.
Может возникнуть возражение:
Пусть компилятор сделает синтаксический анализ и увидит, что «*/» в строке n+1 заключен в кавычки,
т.е. «*/» — это строковый литерал.
Эта пара символов не может быть концом комментария, пусть компилятор ищет этот конец дальше .
Это возражение не может быть принято! Компилятор не должен проводить анализ внутри комментария.
Единственное, что можно ему позволено — это искать символы «*/».
Но что же тогда делать? Иметь вложенные скобочные комментарии всё равно хочется.
Мы, например, скопировали фрагмент кода из другой программы и хотим иметь его в качестве образца.
Или ещё по каким-то причинам нужно фрагмент программы сделать неработающим, отключить его.
Варианты решения проблемы:
-
Один из вариантов выхода видится такой. К тем видам комментариев, которые уже имеются, нужно добавить ещё один.
Специально для того, чтобы фрагменты программ делать неработающими.
Внутри таких комментариев делается синтаксический анализ,
но выходной код для таких участков программы не генерируется.
Этот другой вид комментариев и начинаться должен по-другому, т.е. не так, как обычный длинный (скобочный) комментарий. Но это сложный вариант.
-
Второй вариант — комментарии, имеющие уникальную метку вначале и конце. Этот способ попроще.
-
Ну и самое лёгкое — вообще ничего не делать. Просто программист должен знать о таком нюансе и самостоятельно отслеживать такую редкую ситуацию — последовательность символов «конец комментария» внутри строки.
Опубликовано: 2012.09.25, последняя правка: 2018.11.09 12:43
Отзывы
✅ 2014/06/17 04:26, utkin #0
Есть ещё один вид комментариев это #. Он является стандартом в юникс/линукс.✅ 2014/06/17 16:43, Автор сайта #1
Просто жаль целый символ жертвовать на какой-то комментарий. А вдруг пригодится? Уж лучше тогда «##», это не так жалко :)✅ 2016/08/06 19:05, rst256 #2
А разве одиночные комментарии не удобнее? Они же надежно отключают любой код, и гораздо быстрее обрабатываются.✅ 2016/08/12 10:21, Трурль #3
Но эта же ошибка возникнет и без вложенных комментариев.✅ 2021/03/27 11:56, Виталий Монастырский #4
У меня тоже введены дополнительные виды комментариев. Один из них — это "комментирование кода", специальный вид комментария, предназначенный именно для закрытия отдельных блоков кода во время компиляции. Так же есть ещё пара системных комментариев, в которых я храню настройки для компилятора и константы для словарей автозамены.
Так что полностью поддерживаю автора в необходимости расширения списка комментариев, согласно их функциям. Добавить свой отзыв
Написать автору можно на электронную почту mail(аt)compiler.su
|