Комментарии к коду в различных языках программирования

[Ktina]

Разумеется, было бы намного удобнее, если бы во всех языках программирования комментарии к программному коду имели один и тот же синтаксис.
Однако в действительности мы не наблюдаем ничего подобного, поскольку исторически сложилось совсем иначе, ведь разные языки создавались в разное время и как правило независимо друг от друга.
Поэтому, что поделаешь, приходится для каждого отдельного языка запоминать свой синтаксис (мне пришлось столкнуться с этим, поскольку в эти дни я увлекаюсь веб-дизайном, и даже в HTML и JavaSquirt JavaScript уже не один и тот же синтаксис).
В Википедии имеется список таких синтаксисов (правда, слово "синтаксис" в русском языке не имеет множественного числа ), даже близко не претендующий на полноту, к сожалению.
А где можно увидеть полный или хотя бы почти полный список?

[Anton_Peplov]

Ktina в сообщении #1323502 писал(а):

А где можно увидеть полный или хотя бы почти полный список?

С какой целью интересуетесь? (с) Чтобы увидеть синтаксис комментариев в любом конкретном языке имярек, достаточно, внезапно, поискового запроса "имярек комментарии". Для чего просматривать полный список? Чтобы выбрать язык исходя из того, как там оформляются комментарии? Более странного критерия я не встречал.

Не удивлюсь, если полного списка не существует именно потому, что никто не придумал, зачем он нужен.

[Pphantom]

По-видимому, вот это сойдет: https://en.wikipedia.org/wiki/Comparison_of_programming_languages_%28syntax%29#Comments

[Ktina]

Pphantom
Большое спасибо!

-- 30.06.2018, 11:02 --

Anton_Peplov в сообщении #1323503 писал(а):

С какой целью интересуетесь?

С целью удовлетворения любопытства.

-- 30.06.2018, 11:04 --

Anton_Peplov в сообщении #1323503 писал(а):

Чтобы увидеть синтаксис комментариев в любом конкретном языке имярек, достаточно, внезапно, поискового запроса "имярек комментарии".

Существуют сотни языков программирования. Прикажете делать сотни поисковых запросов? У меня (пардон) рука оторвётся.

[_Ivana]

Чтобы рука не отрывалась от сотен JavaSquirt-ов запросов, программисты дают указание их делать машине. А чтобы потом глаза не отрывались от полученных результатов, дают указания фильтровать и обрабатывать их после получения. В конце концов,

Цитата:

тыж программист, Мишка

[Ktina]

_Ivana в сообщении #1323513 писал(а):

Чтобы рука не отрывалась от сотен JavaSquirt-ов запросов, программисты дают указание их делать машине.

Впервые об этом слышу. В какой среде писать такую программу? Каким образом её потом применять?

[kwakush]

Ktina в сообщении #1323502 писал(а):

А где можно увидеть полный или хотя бы почти полный список?

Ну, например, вот тут https://github.com/antlr/grammars-v4 Полный список синтаксисов, и не только комментариев

[kotenok gav]

Ktina в сообщении #1323597 писал(а):

Каким образом её потом применять?

Я недавно задавался таким же вопросом. «Авторизация»

[Ktina]

kwakush в сообщении #1323600 писал(а):

Ktina в сообщении #1323502 писал(а):

А где можно увидеть полный или хотя бы почти полный список?

Ну, например, вот тут https://github.com/antlr/grammars-v4 Полный список синтаксисов, и не только комментариев

Это своего рода разнобуквица (панграмма) для языков программирования?

[warlock66613]

Ktina в сообщении #1323502 писал(а):

Разумеется, было бы намного удобнее, если бы во всех языках программирования комментарии к программному коду имели один и тот же синтаксис.

Совсем не разумеется. Практически нет никакой разницы между ситуациями "у двух ЯП очень разный синтаксис и вообще они очень разные" и "у двух ЯП очень разный синтаксис и вообще они очень разные, но комментарии в них оформляются одинаково" — в любом случае при переходе от одного к другому требуется "переключение контекста". Разве что вы пишете много бесполезных комментариев... [Потому что полезные бывают двух видов:
1) очень редкие в исключительных случаях (что-то вроде "я так и не смог понять, почему тут надо прибавлять 2, а не 1, и не смог воспроизвести проблему в юнит-тесте, а функциональное тестирование этого куска кода затруднительно)";
2) комментарии-документация, для которых главная проблема — написать их, то есть придумать, и на фоне этой проблемы всякая мелочь вроде "не того" синтаксиса совершенно незаметна.]

[Pphantom]

warlock66613 в сообщении #1323888 писал(а):

Совсем не разумеется. Практически нет никакой разницы между ситуациями "у двух ЯП очень разный синтаксис и вообще они очень разные" и "у двух ЯП очень разный синтаксис и вообще они очень разные, но комментарии в них оформляются одинаково" — в любом случае при переходе от одного к другому требуется "переключение контекста".

В общем-то в современных условиях эта проблема решается однотипным на вид оформлением комментариев и одним и тем же хоткеем комментирования/раскомментирования в любимой среде разработки данного конкретного программиста.

[Anton_Peplov]

warlock66613 в сообщении #1323888 писал(а):

Потому что полезные бывают двух видов:
1) очень редкие в исключительных случаях (что-то вроде "я так и не смог понять, почему тут надо прибавлять 2, а не 1, и не смог воспроизвести проблему в юнит-тесте, а функциональное тестирование этого куска кода затруднительно)";
2) комментарии-документация, для которых главная проблема — написать их, то есть придумать, и на фоне этой проблемы всякая мелочь вроде "не того" синтаксиса совершенно незаметна.

Не знаю, не знаю. На прошлой работе я по заданию начальства писал программу класса "она умеет абсолютно всё, в том числе варит кофе и сталь". Причём по мере того, как перед командой вставали новые задачи, число сортов кофе и марок стали возрастало неограниченно. При последнем её релизе суммарный объём составил около 39 тысяч строк. Количество классов, конструкторов, методов и прочего добра подсчитывать не буду.

Так вот в процессе написания этого монстра я пришёл к глубокому заблуждению, что комментарии вида "эта переменная нужна для для того-то и заполняется там-то" очень облегчают жизнь. Даже если имя переменной длинное и осмысленное (а это, разумеется, так), в него не впихнёшь всю нужную информацию. Например, определяется переменная interval_for_signal_averaging_sec. А в комментарии написано, где и для чего сигнал усредняется по времени, и почему интервал усреднения выбран именно таким. То есть эти комментарии - документация в строгом смысле, но у меня не было никакой проблемы в том, чтобы их придумывать. Поскольку в момент написания метода / класса / бузюки-с-хвостиком ты в контексте и всё про всё помнишь, писать такие комменты можно, слушая музыку и почёсывая нос пяткой. Это объёмно и за счёт этого трудоёмко (но с лихвой окупается тем, что в коде всё и про всё понятно и тебе самому через несколько лет, и тем, кто придёт после тебя, а после меня пришли и вроде не жалуются на качество кода), но отнюдь не требует каких-то интеллектуальных усилий в смысле "придумывания" чего-либо.

[warlock66613]

Anton_Peplov в сообщении #1324010 писал(а):

где и для чего сигнал усредняется по времени, и почему интервал усреднения выбран именно таким. То есть эти комментарии - документация в строгом смысле

Почему интервал усреднения выбран именно таким - этот как раз первый тип: вы не смогли/не захотели написать тест, падающий при изменении интервала усреднения, и вынужденно заменили тест комментарием. Пользу от "где и для чего сигнал усредняется по времени" я заочно и безаппеляционно отбросить не могу, но всё-таки она сомнительна (либо же это так же случай замены теста - падающего при убирании усреднения - комментарием).

[gevaraweb]

Anton_Peplov в сообщении #1324010 писал(а):

Так вот в процессе написания этого монстра я пришёл к глубокому заблуждению, что комментарии вида "эта переменная нужна для для того-то и заполняется там-то" очень облегчают жизнь.

убуждению убеждению?

[Anton_Peplov]

warlock66613 в сообщении #1324014 писал(а):

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

Я, конечно, человек дикий. В смысле, самоучка и программировать учился в процессе работы. Давайте Вы объясните мне этот подход?

Вот есть физическая задача: определить максимальное значение величины, которая меняется на масштабе минут. Это значение - просто максимум на графике зависимости величины от времени. У прибора временное разрешение 0,1 секунды и собственные шумы того же масштаба. Есть ещё шумы от постороннего в данном случае процесса с масштабом 1 секунда. Я чищу сигнал медианным фильтром по 1,5 с, потом сглаживаю обычным / скользящим средним по $n$ секунд и получаю гладенькую кривую, на которой легко найти максимум тупо встроенным методом "максимум заданного массива" и быть уверенным, что полученное число таки от измеряемой величины, а не от шума. В комменты вписываю: "окно медианного фильтра такое-то, а интервал усреднения такой-то, потому что временной масштаб шумов одних такой, других сякой, а полезного сигнала этакий". Какой, по-Вашему, тест и зачем я должен был здесь написать?

gevaraweb в сообщении #1324015 писал(а):

убеждению?

Разумеется. Это я шучу так не смешно. Ещё из моих любимых - "положа сердце на руку".