Короткие комментарии
Не готов предложить новых идей.
Хотя мне нравится короткий комментарий из языка Ада «--», но эту последовательность симолов лучше оставить декременту.
Вариации на тему коротких комметариев в уже существующих языках:
«//» C-подобные языки
«--» Ada
«*» x-Base
«'» Visual Basic
«;» Assembler, Lisp, Scheme
«#> Python
Если ли большой смысл отказываться от Си-шного короткого комментария «//»?
В языке Ада нет декремента, поэтому там легко использовать «--».
Символы «*», «'», «;» и «#» слишком ценны, чтобы их целиком отдавать под короткий комментарий.
Двойные «**», «''» и «;;» — это было бы приемлемее и не так расточительно.
Наверное, «//» вполне подходящ.
Хотя «;;» и «##» тоже неплохи.
Пример:
// короткий комментарий — это любой текст до конца строки
;; можно и такой комментарий попробовать
## и такой тоже
Опубликовано: 2012.09.25, последняя правка: 2014.12.04 09:36
Отзывы
✅ 2012/10/05 08:22, utkin #0
«#» Python Это имеет логичное объяснение. Питон в основном обосновался в линукс/юникс. Там # фактически стандарт комментария (из-за коммандных интерпретаторов).✅ 2014/01/31 09:36, Pensulo #1
Позвольте раскритиковать ваши варианты решения данного вопроса в пух и в прах. Удвоенный знак умножения мог бы вполне себе использоваться как обозначение операции возведения в степень (z = x ** y ). Удвоенный знак одинарной кавычки визуально почти не отличается от одинарного знака двойной кавычки ('' = "). Удвоенный знак точки с запятой можно было бы вполне себе законно трактовать как пропущенный оператор, а вовсе не как знак комментария ( a = b;; c = a ), если одинарный знак при этом обозначает ещё и завершение оператора. Обилие знаков # затемняет собственно текст самого комментария и к тому же требует переключения раскладки на английский язык, если конечно не разрешить также альтернативное употребление "кириллического" знака №. Последнее замечание, кстати справедливо и для знака правый слэш, который, для освобождения от необходимости скакать по раскладкам, предпочтительнее было бы заменить на левый слэш.
Кстати, в VisualBasic вопрос с комментариями решён весьма органичным способом — употреблением знака одинарной кавычки. При этом, надо иметь ввиду, что в языке синтаксически нет длинных комментариев, что не мешает однако длинные комментарии употреблять. В этом случае используются возможности IDE по автоматическому предварению (или наоборот устранению) каждой строки выбранного блока знаком короткого комментария. Практика показывает что такое решение также устраняет и проблему употребления вложенных длинных комментариев.
Всё таки в M$ разработчики не даром едят свой хлеб, по крайней мере в том подразделении которое занимается VB.✅ 2014/01/31 15:13, Автор сайта #2
Насчёт «**», «;;», «#» согласен с Вами. Использование «\\» как начало короткого комментария — хорошая идея. Правда, ещё один товарищ, обсуждающий со мной черты языка, предлагает использовать обозначение «\» как операцию целочисленного деления, а «\\» — как взятие остатка от деления.
Идея перепоручить среде разработки делать длинные комментарии из нескольких коротких не нравится. Программист должен иметь возможность работать без этой среды, в простом текстовом редакторе.
Одинарная кавычка пригодится в другом качестве. В PHP текстовые литералы можно заключать как в двойные, так и в одинарные кавычки. Это удобно: когда в среди символов встречаются двойные кавычки, то литерал надо заключить в одинарные. И наоборот.✅ 2014/04/23 02:31, Utkin #3
// Есть и в Си и в Паскале, на цифровой клавиатуре вводится на любой раскладке. Вполне годный вариант комментария.✅ 2014/05/23 06:46, Pensulo #4
Utkin Я, прошу прощения, но уже давно работаю сугубо за ноутбуками разных моделей и обособленную цифровую часть клавиатуры уже давно не использую (вследствие различий её реализации в разных моделях ноутбуков). Посему не вижу для себя удобства в употреблении знака '/'. Кстати, хотя вы наверняка это знаете, однако напомню что клавиша помеченная как '.' на цифровой части клавиатуры зависит от региональных настроек текущего выбранного языка ввода. В русском это — запятая, а в английском — точка. И это тоже отбивает охоту использовать эту часть клавиатуры.
Автор сайта Предложение по взятию остатку через "\\" — хорошее, но в этом конфликте функций надо предпочесть одно другому исходя из наибольшей важности для проектируемого языка, например, ориентируясь на частотность задействования той или иной функции.✅ 2014/06/17 04:30, utkin #5
Pensulo Очевидно, что здесь нет однозначного ответа и надо идти на компромисс. То есть чем-то жертвовать: либо удобством, либо традициями, либо ясностью и т.д. И ещё — все-таки ноуты по-прежнему не предназначены для серьезной работы. Я понимаю, работа, поездки и все такое, но пока факт остается фактом — ноуты не предназначены для серьезной и длительной работы над большими проектами (тут и клава и экран и усталость программера).✅ 2014/06/17 16:41, Автор сайта #6
Так получилось, что я уже 9-й год с одним и тем же ноутбуком и дома, и на работе, и в дороге. Уже привык. Обычная клавиатура меня уже раздражает.✅ 2020/08/04 23:06, Иван #7
Чем плох короткий комментарий Фортрана: ! <комментарий>?✅ 2020/08/04 23:42, Автор сайта #8
Символ «!» традиционно используют для обозначения унарной логической операции «не». Если этот символ использовать для короткого комментария, то для «не» придётся придумывать другое обозначение.✅ 2020/10/08 07:58, NuShaman #9
Понятие «короткий комментарий» более логично обозвать понятием «однострочный комментарий», потому что он комментирует текст, который идёт после него до конца строки, и на следующую строку однострочный комментарий уже не действует.
Есть ещё понятие «многострочный комментарий». Например, в Си он начинается как «/*» и закончивается как «*/».
В версии 0.3 интерпретатора РЯП RusSolo я уже реализовал однострочный комментарий «;» (точка с запятой).✅ 2020/10/08 23:00, Автор сайта #10
Это разные названия одних и тех же вещей. По-моему, они никого не вводят в заблуждение, не вызывают путаницы. Все и так понимают, о чём речь. Добавить свой отзыв
Написать автору можно на электронную почту mail(аt)compiler.su
|