JavaScript: Комментарии
Кроме кода, в файлах с исходным кодом могут находиться комментарии. Это текст, который не является частью программы и нужен программистам для пометок. С их помощью добавляют пояснения, как работает код, какие здесь ошибки нужно поправить или не забыть что-то добавить позже.
// Удалить строку ниже после реализации задачи по регистрации console.log(10); Комментарии в JavaScript бывают двух видов:
Однострочные комментарии
Однострочные комментарии начинаются с // . После этих двух символов может следовать любой текст, вся строчка не будет анализироваться и исполняться.
Комментарий может занимать всю строчку. Если одной строчки мало, то создаются несколько комментариев:
// For Winterfell! // For Lanisters! Комментарий может находиться на строчке после какого-нибудь кода:
console.log('I am the King'); // For Lannisters! Многострочные комментарии
Многострочные комментарии начинаются с /* и заканчиваются на */ .
/* The night is dark and full of terrors. */ console.log('I am the King'); Такие комментарии, обычно, используют для документирования кода, например, функций.
Задание
Создайте однострочный комментарий с текстом: You know nothing, Jon Snow! .
Упражнение не проходит проверку — что делать? ��
Если вы зашли в тупик, то самое время задать вопрос в «Обсуждениях». Как правильно задать вопрос:
- Обязательно приложите вывод тестов, без него практически невозможно понять что не так, даже если вы покажете свой код. Программисты плохо исполняют код в голове, но по полученной ошибке почти всегда понятно, куда смотреть.
В моей среде код работает, а здесь нет ��
Тесты устроены таким образом, что они проверяют решение разными способами и на разных данных. Часто решение работает с одними входными данными, но не работает с другими. Чтобы разобраться с этим моментом, изучите вкладку «Тесты» и внимательно посмотрите на вывод ошибок, в котором есть подсказки.
Мой код отличается от решения учителя ��
Это нормально ��, в программировании одну задачу можно выполнить множеством способов. Если ваш код прошел проверку, то он соответствует условиям задачи.
В редких случаях бывает, что решение подогнано под тесты, но это видно сразу.
Прочитал урок — ничего не понятно ��
Создавать обучающие материалы, понятные для всех без исключения, довольно сложно. Мы очень стараемся, но всегда есть что улучшать. Если вы встретили материал, который вам непонятен, опишите проблему в «Обсуждениях». Идеально, если вы сформулируете непонятные моменты в виде вопросов. Обычно нам нужно несколько дней для внесения правок.
Кстати, вы тоже можете участвовать в улучшении курсов: внизу есть ссылка на исходный код уроков, который можно править прямо из браузера.
Полезное
Определения
- Комментарий — текст в коде программы, который не влияет на функциональность и добавляется программистами для себя и своих коллег. // однострочный комментарий
/* многострочный комментарий многострочный комментарий */ Комментарии в Python
Основы
Автор Иван Душенко На чтение 9 мин Просмотров 3.6к. Опубликовано 08.06.2021
Введение в тему
Язык программирования – это что-то среднее между человеческим языком (естественным) и языком машин (бинарным). Именно поэтому нам, людям, понимать код не так просто, как привычную речь. Из-за этого иногда так сложно разобраться в программах, написанных другими людьми или самим собой, но когда-то давно. Для того, чтоб облегчить понимание кода, во многих языках программирования введён такой инструмент, как комментарии. В том числе, можно писать комментарии в Python.
Комментарии – это неисполняемые части кода на естественном языке (чаще всего на английском, но могут быть и на русском). Для их использования определён специальный синтаксис, который мы разберём в этом уроке. Комментарий python может быть однострочным и многострочным.
Использовать комментарии python считается хорошим подходом к программированию. Они помогают проводить код-ревью, реверс инжиниринг, рефакторинг, создавать документацию. Используются не только программистами, но и тестировщиками.
Писать комментарии лучше в процессе кодирования, а не после: Вы можете забыть какую-то подробность, либо отложить это в «далёкий ящик» и увеличить тем самым технический долг.
Писать в комментариях лучше всего не о том, как работает данный участок кода, а о том почему выбран именно данный подход (алгоритм, технология, и т. д.).
Если проект маленький – это вовсе не означает, что не надо его комментировать. Так как понять свой же код, спустя долгое время, бывает совсем не просто, пожалейте себя же будущего. Запомните: любой программист тратит гораздо больше времени на чтение кода, чем на само кодирование!
Комментирование — это важная часть работы программиста и правило хорошего тона. В этом уроке Вы узнаете о различных Python comments и о так называемых строках документации.
Однострочные комментарии в python
Для написания комментариев в Питоне используется символа хеша #. Комментарий начинается с этого символа и продолжается до конца строки.
Пример комментария из «боевого» кода, модуль ctypes стандартной библиотеки:
Java: Комментарии
Практически все языки программирования позволяют оставлять в коде комментарии. Они никак не используются кодом и нужны исключительно для людей: чтобы программист оставлял пометки для себя и для других программистов.
Комментарии в Java бывают трех видов:
-
Однострочные комментарии начинаются с // . После этих двух символов может следовать любой текст, вся строка не будет анализироваться и исполняться. Комментарий может занимать всю строку:
// For Winterfell! Также комментарий может находиться на строке после какого-нибудь кода:
System.out.println("I am the King"); // => For Lannisters! /* * The night is dark and * full of terrors. */ System.out.println("I am the King"); // => I am the King Задание
Создайте однострочный комментарий с текстом: You know nothing, Jon Snow!.
Упражнение не проходит проверку — что делать? ��
Если вы зашли в тупик, то самое время задать вопрос в «Обсуждениях». Как правильно задать вопрос:
- Обязательно приложите вывод тестов, без него практически невозможно понять что не так, даже если вы покажете свой код. Программисты плохо исполняют код в голове, но по полученной ошибке почти всегда понятно, куда смотреть.
В моей среде код работает, а здесь нет ��
Тесты устроены таким образом, что они проверяют решение разными способами и на разных данных. Часто решение работает с одними входными данными, но не работает с другими. Чтобы разобраться с этим моментом, изучите вкладку «Тесты» и внимательно посмотрите на вывод ошибок, в котором есть подсказки.
Мой код отличается от решения учителя ��
Это нормально ��, в программировании одну задачу можно выполнить множеством способов. Если ваш код прошел проверку, то он соответствует условиям задачи.
В редких случаях бывает, что решение подогнано под тесты, но это видно сразу.
Прочитал урок — ничего не понятно ��
Создавать обучающие материалы, понятные для всех без исключения, довольно сложно. Мы очень стараемся, но всегда есть что улучшать. Если вы встретили материал, который вам непонятен, опишите проблему в «Обсуждениях». Идеально, если вы сформулируете непонятные моменты в виде вопросов. Обычно нам нужно несколько дней для внесения правок.
Кстати, вы тоже можете участвовать в улучшении курсов: внизу есть ссылка на исходный код уроков, который можно править прямо из браузера.
Кипиш с подсказками в VS code CSS?
Здравствуйте, случилась такая проблема, сижу пишу код, делаю веб страничку не первый час, и при написании кода в CSS, высвечивается одна подсказка, я удивился, ведь в течении всего времени, что я писал код, у меня высвечивалось намного больше подсказок (4, 5, 6 и т.д.),типо какие значения сюда можно вообще подставить, но теперь высвечивается только одно, как исправить это, надеюсь на помощь!
- Вопрос задан более трёх лет назад
- 1355 просмотров
Комментировать
Решения вопроса 0
Ответы на вопрос 2
Аналогичная проблема. При чем похоже что Emmet стал слабо работать либо перестал работать совсем. Думал только с CSS такое. Неа. с JS и HTML тоже самое слева пример того, как были подсказки до, справа после
З.Ы.
Проблема решена тем, что окошко было просто уменьшено вручную.
Ответ написан более трёх лет назад
Комментировать
Нравится 1 Комментировать
Токсичный шарпист
1. Проверьте, установлен ли плагин для CSS
2. Проверьте, что никаких ошибок в файле нет (автокомплит иногда может не работать, если синтаксис кривой)
3. Проверьте, что сам плагин не упал (в логах будет ошибка, если упал)
4. Убедитесь, что действительно есть, что что-то должно автодоплняться.
PS: неплохо было бы прикрепить пример файла, в котором якобы всё сломалось
Ответ написан более трёх лет назад
Комментировать
Нравится Комментировать
Ваш ответ на вопрос
Войдите, чтобы написать ответ
- JavaScript
- +2 ещё
Как настроить отладку в VS Code для chrome?
- 1 подписчик
- 53 минуты назад
- 30 просмотров