Комментарии к коду в различных языках программирования
Комментарии к коду в различных языках программирования
30.06.2018, 09:56
Разумеется, было бы намного удобнее, если бы во всех языках программирования комментарии к программному коду имели один и тот же синтаксис.
Однако в действительности мы не наблюдаем ничего подобного, поскольку исторически сложилось совсем иначе, ведь разные языки создавались в разное время и как правило независимо друг от друга.
Поэтому, что поделаешь, приходится для каждого отдельного языка запоминать свой синтаксис (мне пришлось столкнуться с этим, поскольку в эти дни я увлекаюсь веб-дизайном, и даже в HTML и JavaSquirt JavaScript уже не один и тот же синтаксис).
В Википедии имеется список таких синтаксисов (правда, слово «синтаксис» в русском языке не имеет множественного числа ), даже близко не претендующий на полноту, к сожалению.
А где можно увидеть полный или хотя бы почти полный список?
Re: Комментарии к коду в различных языках программирования
30.06.2018, 10:09
Ktina в сообщении #1323502 писал(а):
А где можно увидеть полный или хотя бы почти полный список?
ДМИТРИЙ ПЕТРОВ — НЕ ПОЛИГЛОТ, НЕ ПЕРЕВОДЧИК, НЕ ЛИНГВИСТ | Английский за 16 часов | Культура
С какой целью интересуетесь? (с) Чтобы увидеть синтаксис комментариев в любом конкретном языке имярек, достаточно, внезапно, поискового запроса «имярек комментарии». Для чего просматривать полный список? Чтобы выбрать язык исходя из того, как там оформляются комментарии? Более странного критерия я не встречал.
Не удивлюсь, если полного списка не существует именно потому, что никто не придумал, зачем он нужен.
Re: Комментарии к коду в различных языках программирования
30.06.2018, 10:31
Re: Комментарии к коду в различных языках программирования
30.06.2018, 11:01
Последний раз редактировалось Ktina 30.06.2018, 11:04, всего редактировалось 2 раз(а).
Pphantom
Большое спасибо!
Anton_Peplov в сообщении #1323503 писал(а):
С какой целью интересуетесь?
С целью удовлетворения любопытства.
Anton_Peplov в сообщении #1323503 писал(а):
Чтобы увидеть синтаксис комментариев в любом конкретном языке имярек, достаточно, внезапно, поискового запроса «имярек комментарии».
Существуют сотни языков программирования. Прикажете делать сотни поисковых запросов? У меня (пардон) рука оторвётся.
Re: Комментарии к коду в различных языках программирования
30.06.2018, 11:29
Последний раз редактировалось _Ivana 30.06.2018, 11:32, всего редактировалось 1 раз.
Чтобы рука не отрывалась от сотен JavaSquirt-ов запросов, программисты дают указание их делать машине. А чтобы потом глаза не отрывались от полученных результатов, дают указания фильтровать и обрабатывать их после получения. В конце концов,
Цитата:
тыж программист, Мишка
Re: Комментарии к коду в различных языках программирования
30.06.2018, 17:26
Последний раз редактировалось Ktina 30.06.2018, 17:26, всего редактировалось 1 раз.
_Ivana в сообщении #1323513 писал(а):
Как быстро выучить любой язык программирования в 2023 году?
Чтобы рука не отрывалась от сотен JavaSquirt-ов запросов, программисты дают указание их делать машине.
Впервые об этом слышу. В какой среде писать такую программу? Каким образом её потом применять?
Re: Комментарии к коду в различных языках программирования
30.06.2018, 17:46
Последний раз редактировалось kwakush 30.06.2018, 17:47, всего редактировалось 1 раз.
Ktina в сообщении #1323502 писал(а):
А где можно увидеть полный или хотя бы почти полный список?
Ну, например, вот тут https://github.com/antlr/grammars-v4 Полный список синтаксисов, и не только комментариев
Re: Комментарии к коду в различных языках программирования
30.06.2018, 18:15
Ktina в сообщении #1323597 писал(а):
Каким образом её потом применять?
Я недавно задавался таким же вопросом. «Авторизация»
Re: Комментарии к коду в различных языках программирования
30.06.2018, 22:46
kwakush в сообщении #1323600 писал(а):
Ktina в сообщении #1323502 писал(а):
А где можно увидеть полный или хотя бы почти полный список?
Ну, например, вот тут https://github.com/antlr/grammars-v4 Полный список синтаксисов, и не только комментариев
Это своего рода разнобуквица (панграмма) для языков программирования?
Re: Комментарии к коду в различных языках программирования
02.07.2018, 00:44
Последний раз редактировалось warlock66613 02.07.2018, 01:01, всего редактировалось 2 раз(а).
Ktina в сообщении #1323502 писал(а):
Разумеется, было бы намного удобнее, если бы во всех языках программирования комментарии к программному коду имели один и тот же синтаксис.
Совсем не разумеется. Практически нет никакой разницы между ситуациями «у двух ЯП очень разный синтаксис и вообще они очень разные» и «у двух ЯП очень разный синтаксис и вообще они очень разные, но комментарии в них оформляются одинаково» — в любом случае при переходе от одного к другому требуется «переключение контекста». Разве что вы пишете много бесполезных комментариев. [Потому что полезные бывают двух видов:
1) очень редкие в исключительных случаях (что-то вроде «я так и не смог понять, почему тут надо прибавлять 2, а не 1, и не смог воспроизвести проблему в юнит-тесте, а функциональное тестирование этого куска кода затруднительно)»;
2) комментарии-документация, для которых главная проблема — написать их, то есть придумать, и на фоне этой проблемы всякая мелочь вроде «не того» синтаксиса совершенно незаметна.]
Re: Комментарии к коду в различных языках программирования
02.07.2018, 01:09
warlock66613 в сообщении #1323888 писал(а):
Совсем не разумеется. Практически нет никакой разницы между ситуациями «у двух ЯП очень разный синтаксис и вообще они очень разные» и «у двух ЯП очень разный синтаксис и вообще они очень разные, но комментарии в них оформляются одинаково» — в любом случае при переходе от одного к другому требуется «переключение контекста».
В общем-то в современных условиях эта проблема решается однотипным на вид оформлением комментариев и одним и тем же хоткеем комментирования/раскомментирования в любимой среде разработки данного конкретного программиста.
Re: Комментарии к коду в различных языках программирования
02.07.2018, 19:13
Последний раз редактировалось Anton_Peplov 02.07.2018, 19:14, всего редактировалось 1 раз.
warlock66613 в сообщении #1323888 писал(а):
Потому что полезные бывают двух видов:
1) очень редкие в исключительных случаях (что-то вроде «я так и не смог понять, почему тут надо прибавлять 2, а не 1, и не смог воспроизвести проблему в юнит-тесте, а функциональное тестирование этого куска кода затруднительно)»;
2) комментарии-документация, для которых главная проблема — написать их, то есть придумать, и на фоне этой проблемы всякая мелочь вроде «не того» синтаксиса совершенно незаметна.
Не знаю, не знаю. На прошлой работе я по заданию начальства писал программу класса «она умеет абсолютно всё, в том числе варит кофе и сталь». Причём по мере того, как перед командой вставали новые задачи, число сортов кофе и марок стали возрастало неограниченно. При последнем её релизе суммарный объём составил около 39 тысяч строк. Количество классов, конструкторов, методов и прочего добра подсчитывать не буду.
Так вот в процессе написания этого монстра я пришёл к глубокому заблуждению, что комментарии вида «эта переменная нужна для для того-то и заполняется там-то» очень облегчают жизнь. Даже если имя переменной длинное и осмысленное (а это, разумеется, так), в него не впихнёшь всю нужную информацию. Например, определяется переменная interval_for_signal_averaging_sec.
А в комментарии написано, где и для чего сигнал усредняется по времени, и почему интервал усреднения выбран именно таким. То есть эти комментарии — документация в строгом смысле, но у меня не было никакой проблемы в том, чтобы их придумывать. Поскольку в момент написания метода / класса / бузюки-с-хвостиком ты в контексте и всё про всё помнишь, писать такие комменты можно, слушая музыку и почёсывая нос пяткой. Это объёмно и за счёт этого трудоёмко (но с лихвой окупается тем, что в коде всё и про всё понятно и тебе самому через несколько лет, и тем, кто придёт после тебя, а после меня пришли и вроде не жалуются на качество кода), но отнюдь не требует каких-то интеллектуальных усилий в смысле «придумывания» чего-либо.
Re: Комментарии к коду в различных языках программирования
02.07.2018, 19:28
Anton_Peplov в сообщении #1324010 писал(а):
где и для чего сигнал усредняется по времени, и почему интервал усреднения выбран именно таким. То есть эти комментарии — документация в строгом смысле
Почему интервал усреднения выбран именно таким — этот как раз первый тип: вы не смогли/не захотели написать тест, падающий при изменении интервала усреднения, и вынужденно заменили тест комментарием. Пользу от «где и для чего сигнал усредняется по времени» я заочно и безаппеляционно отбросить не могу, но всё-таки она сомнительна (либо же это так же случай замены теста — падающего при убирании усреднения — комментарием).
Re: Комментарии к коду в различных языках программирования
02.07.2018, 19:32
Anton_Peplov в сообщении #1324010 писал(а):
Так вот в процессе написания этого монстра я пришёл к глубокому заблуждению, что комментарии вида «эта переменная нужна для для того-то и заполняется там-то» очень облегчают жизнь.
убуждению убеждению?
Re: Комментарии к коду в различных языках программирования
02.07.2018, 19:48
warlock66613 в сообщении #1324014 писал(а):
Почему интервал усреднения выбран именно таким — этот как раз первый тип: вы не смогли/не захотели написать тест, падающий при изменении интервала усреднения, и вынужденно заменили тест комментарием.
Я, конечно, человек дикий. В смысле, самоучка и программировать учился в процессе работы. Давайте Вы объясните мне этот подход?
Вот есть физическая задача: определить максимальное значение величины, которая меняется на масштабе минут. Это значение — просто максимум на графике зависимости величины от времени. У прибора временное разрешение 0,1 секунды и собственные шумы того же масштаба. Есть ещё шумы от постороннего в данном случае процесса с масштабом 1 секунда.
Я чищу сигнал медианным фильтром по 1,5 с, потом сглаживаю обычным / скользящим средним по секунд и получаю гладенькую кривую, на которой легко найти максимум тупо встроенным методом «максимум заданного массива» и быть уверенным, что полученное число таки от измеряемой величины, а не от шума. В комменты вписываю: «окно медианного фильтра такое-то, а интервал усреднения такой-то, потому что временной масштаб шумов одних такой, других сякой, а полезного сигнала этакий». Какой, по-Вашему, тест и зачем я должен был здесь написать?
gevaraweb в сообщении #1324015 писал(а):
Разумеется. Это я шучу так не смешно. Ещё из моих любимых — «положа сердце на руку».
| Страница 1 из 2 | [ Сообщений: 25 ] | На страницу 1 , 2 След. |
Источник: dxdy.ru
На каком языке писать комментарии в коде?
Уже около года пишу комментарии в коде только на английском языке. С одной стороны, так мой код становится менее понятным людям, которые не знают английский или могут просто не разобрать то, что я написал (sorry for my english и тд.). С другой стороны, писать комментарии на английском модно и круто, сам не знаю почему, все так делают. Так какой же язык выбрать для комментариев? Какой выбираете вы?
- Вопрос задан более трёх лет назад
- 1660 просмотров
Комментировать
Решения вопроса 0
Ответы на вопрос 7
Ну мне кажется вопрос очевиден, смотря для кого Вы пишете код.
Если вы в команде русскоязычных разработчиков — можно и на русском.
А если какой-то Open Source проект, то конечно лучше бы на международном английском.
Ответ написан более трёх лет назад
Комментировать
Нравится 6 Комментировать
Русский программист из Челябинска
Удобно писать на английском, потому что для большинства существующих готовых решений это стандарт де-факто. Ну то есть даже терминология английская зачастую будет понятнее, чем русские аналоги, потому что нету нигде единого стандарта как и что переводить.
Но если команда russian-only (это плохо), то можно писать русские комментарии, но тогда нужно какой-то глоссарий использовать, чтобы не было разных интерпртаций одного и того же английского понятия.
Ответ написан более трёх лет назад
Нравится 1 2 комментария
а еще раскладку клавиатуры не нужно переключать 🙂
Последнее время часто пишу на обоих.
При этом комменты на английском делаю очень лаконичные, в основном обозначающие суть того, что происходит и для чего. На русском расширенно описываю, например часто добавляю не только что и для чего, но и почему именно так.
Ответ написан более трёх лет назад
Комментировать
Нравится 1 Комментировать
Все очевидно же
Для себя — на каком удобнее
Для русских — на русском
Для остальных — на английском
Не уверены кто будет потом после вас — на английском
P.s. немного зла — habrahabr.ru/post/207390 🙂
Ответ написан более трёх лет назад
Комментировать
Нравится 1 Комментировать
Open Source enthusiast
Если Open Source — только английский, если закрытый код — зависит от ситуации, но обычно лучше английский, мало ли кто будет поддерживать потом ваш код.
Ответ написан более трёх лет назад
Комментировать
Нравится Комментировать
Еда — это святое
На английском — лень по 10 раз переключать раскладку.
Ответ написан более трёх лет назад
Комментировать
Нравится Комментировать
Присоединяюсь к вопросу. Только беспокоит другое, написать можно и на обоих. А вот реально ли на гитхабе или просто у себя где-то в гите держать параллельно 2 версии, где код идентичен, а комменты на русском.
Вот хочу я залить одну прогу на гитхаб и чтобы охват был от русских чайников до всех остальных, но походу постоянно следить за этим будет невозможно, мержить построчно каждый файл и вообще непонятная история будет складываться как минимум в одной репе, а то и в обеих. Единственное, что пока пришло в голову это каждому методу давать номер типа #2743 и чтобы был скрипт, который бы скачал и вставил комменты в нужные места. Можно было бы совместить енг и номерки для дорогих россиян чтобы они могли скачать себе великие и могучие комменты, но это прокатит только для комментов перед методами, а внутри методов тоже бывают. Кто что думает?
Источник: qna.habr.com
Мультиязычные комментарии в Java-коде
Хочу выложить свой первый проект на GitHub для Android. Проект как на рус. так и на англ. языке. Код прокомментирован на русском языке, хочу также его прокомментировать еще и на английском как минимум. Подскажите, как это лучше сделать? Как это делают, может есть какие-то статьи почитать?
Погуглил — толком ничего не нашел. Не в скобках же писать на английском языке коммент после русского.
Отслеживать
12.7k 10 10 золотых знаков 37 37 серебряных знаков 75 75 бронзовых знаков
задан 19 июл 2013 в 8:06
93 1 1 золотой знак 1 1 серебряный знак 10 10 бронзовых знаков
> Не в скобках же писать на английском > языке коммент после русского. ну а как по другому?
19 июл 2013 в 8:11
27 мая 2016 в 7:05
Убрал любой-язык
27 мая 2016 в 8:17
27 мая 2016 в 13:27
2 ответа 2
Сортировка: Сброс на вариант по умолчанию
Если проект мультиязычный, то он комментируется ТОЛЬКО на английском языке. Всё.
Отслеживать
ответ дан 19 июл 2013 в 8:11
2,377 13 13 серебряных знаков 20 20 бронзовых знаков
Да и во всех остальных случаях так же желательно использовать английский язык для комментирования и документации, ибо редко когда возможно заранее утверждать, что к проекту не будут привлекаться носители другого языка.
19 июл 2013 в 11:08
Не знаю, я в code.google.com комментировал как-то так: // Блок управления очередью и свободными блоками typedef struct < Q_BLOCK head, *tail, *flist, // список свободных блоков, полученных malloc() . > DATA_QUEUE; / // The control unit queue and free blocks typedef struct < Q_BLOCK * head, * tail, * flist, // list of free blocks received malloc () . >DATA_QUEUE; */ и вроде никто не ругался.
19 июл 2013 в 19:12
Зачем так категорично? Комментировать можно на любом языке, только навряд ли такой код заинтересует кого-то кроме носителей родного языка комментатора.
27 мая 2016 в 7:44
** * English * Русский */ class Foo
Отслеживать
ответ дан 19 июл 2013 в 8:16
17.7k 3 3 золотых знака 44 44 серебряных знака 85 85 бронзовых знаков
Это явно не для [любого языка] подходит.
27 мая 2016 в 5:35
27 мая 2016 в 7:04
А, точняк. Это он, конечно, зря сделал.
27 мая 2016 в 7:05
27 мая 2016 в 13:32
Источник: ru.stackoverflow.com