Продолжаем изучать язык программирования C.
И сегодня мы научимся писать комментарии к коду.
Порой не всегда инструкции, команды, а также директивы позволяют при чтении исходного кода быстро понять, что же вообще происходит в коде, за что отвечает тот или иной участок кода, что он вообще делает.
И тут нам на помощь приходят комментарии. Они позволяют нам в любом месте исходного кода нашей программы писать какие-либо подсказки о нашем коде для того, чтобы мы в будущем, когда код достигнет внушительных размеров, могли понять для чего мы это писали и что в данном месте вообще делается.
Также комментарии помогают нам участок кода, который мы не хотим, чтобы выполнялся программой, но, возможно, в дальнейшем он нам пригодится, спрятать от компилятора, но пока не удалять. Мы данный участок кода превращаем в комментарий и он, хоть и не будет удалён из файла с исходным кодом, выполняться не будет.
Вот зачем нам нужны комментарии.
Теперь, собственно, давайте разберёмся, как их вообще писать в коде и как заставить компилятор их не выполнять.
Если мы хотим написать комментарий в одной строке (либо в конце строки), то мы используем для этого знак «//» (двойная косая черта, кавычки не входят). Данный знак мы ставим перед текстом с комментарием. То есть, всё то, что в данной строке находится после данного знака, будет считаться комментарием и интерпретироваться компилятором не будет, следовательно и выполняться затем тоже.
Конечно же мы можем наши комментарии написать и в несколько строк, используя тот же знак двух косых чёрточек, только мы будем вынуждены данный знак ставить вначале каждой из этих строк. Хорошо, когда таких строк немного, а вот если их, например, 50, или даже 100, то для этого есть другой способ.
Если мы хотим написать комментарий из нескольких строк либо «закомментировать», чтобы впоследствии не выполнять какой-то участок кода, то мы используем два символа: «/*» и «*/«. Первый из этих символов (косая черта и звёздочка) используется вначале комментария, а вторая (звёздочка и косая черта) — в его конце. Мы также можем такие символы использовать и в одной строке, например, если мы хотим закомментировать её участок где-то в начале или в середине.
Есть ещё один способ добавлять комментарий. Он также очень интересен и не всегда документирован, так как он никак не подсвечивается с помощью подсветки синтаксиса (комментарии, добавленные с помощью предыдущих двух способов как правило подсвечиваются зелёным цветом), да и, по большому счёту он и комментарием-то не является, но работает так же как и обычные комментарии. Данный способ применяется в случае также комментирования нескольких строк. Перед первой комментируемой строкой мы пишем строку с директивой «#if 0«. Это условная директива, с такими директивами препроцессора мы будем знакомиться позже, поэтому я лишь скажу, что это условие, в тело которого мы никогда не попадём, так как оно никогда не может быть истинным. Поэтому после этой директивы дальнейший код не будет выполняться. А после последней строки, которую мы хотим комментировать, мы пишем строку с директивой «#endif«, которая будет означать окончание нашего условия. Поэтому весь тот код, который будет расположен между данными директивами, выполняться никогда не будет и, следовательно, также будет являться комментарием.
Когда именно нам может пригодиться третий способ и почему нельзя использовать второй? А потому, что порой ,причем зачастую, случаются такие ситуации, когда уже присутствуют многострочные комментарии в участке кода, который мы хотим закомментировать, То второй способ уже не сработает. Мало того, он закончится ошибкой использования некорректных символов. В этом случае нам на помощь и придёт третий способ.
Но а чтобы нам не путаться , что, где и как используется и как это работает, предлагаю всё это проделать на практике. Для этого мы создадим новую папку с именем, например, MYPROG03 и скопируем в неё содержимое нашего прежнего проекта (файл main.c и два cmd-файла). В файле build.cmd myprog02 заменим на myprog03 вот здесь
Откроем файл main.c и напишем наш первый комментарий вначале тела функции main(), тем самым обеспечив себе в будущем напоминание о том, что у нас здесь делается (да и не только себе, вдруг мы захотим поделиться своим творением с кем-то, он тем более может не понять нашего кода, не он же его писал)
|
1 2 3 |
//Output a string to the console printf("String: "); printf("%s\r\n","Hello, World!!!"); |
Мы написали здесь, что здесь у нас будет производиться вывод строки в консоль.
Давайте подобные комментарии напишем перед каждым подобным участком кода. Получится вот так
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
//Output a string to the console printf("String: "); printf("%s\r\n","Hello, World!!!"); //Output character to console printf("Char: "); printf("%c\r\n",131); //Output a signed integer to the console printf("Signed integer: "); printf("%d\r\n",3000000000); //Output a unsigned integer to the console printf("Unigned integer: "); printf("%u\r\n",3000000000); //Output a signed short integer to the console printf("Signed short: "); printf("%hd\r\n",40000); //Output a unsigned short integer to the console printf("Unsigned short: "); printf("%hu\r\n",40000); //Output a signed long integer to the console printf("Signed long: "); printf("%I64d\r\n",18446744073709551615); //Output a unsigned long integer to the console printf("Unsigned long: "); printf("%llu\r\n",18446744073709551615); //Outputting a floating-point number to the console printf("Float: "); printf("%f\r\n",12.456f); //Outputting a 64-bit floating-point number to the console printf("Double: "); printf("%lf\r\n",12345.67891); //Hex output to console printf("Hex: "); printf("0x%llX\r\n",3000000000); |
Попробуем также написать комментарий в конце последней строки тела
|
1 |
return 0; //Return an integer from a function |
Попробуем собрать наш код и запустить программу
У нас по-прежнему всё работает.
Теперь давайте в самом начале файла добавим многострочный комментарий, обычно там добавляют информацию об авторе кода
|
1 2 3 4 5 6 |
/* Author: Ivanov Ivan Date: 2019.04.05 Theme: Using comments in the C language */ #include <stdio.h> |
Данный участок кода также не будет никак интерпретироваться.
Таким же способом попробуем закомментировать участок кода. Например, мы не хотим. чтобы у нас выводилось беззнаковое число короткого типа
|
1 2 3 4 5 |
/* //Output a unsigned short integer to the console printf("Unsigned short: "); printf("%hu\r\n",40000); */ |
Соберём код и запустим программу
Данный тип у нас теперь не выводится, то есть закомментированный участок кода не выполняется. Теперь попробуем закомментировать большой участок кода. Причём специально выберем такой участок, в который войдёт только что закомментированный участок. Начальный знак комментария мы поставим здесь
|
1 2 |
/* //Output a signed integer to the console |
А конечный — здесь
|
1 2 |
*/ //Outputting a floating-point number to the console |
То есть мы хотим, чтобы у нас вообще никакие целые числа не выводились в консоль.
И в этом случае нам даже самый обычный notepad++ не подсветит весь комментарий, а подсвечивание закончится на уже использованном до этого знаке окончания комментария
Попробуем собрать наш код, и мы получим вот такую ошибку, о которой я уже рассказывал
Поэтому давайте уберём последний комментарий — и открывающий и закрывающий знаки и вместо них напишем директивы, используя третий способ комментирования
Хоть у нас ничего и не подсвечивается, но тем не менее при сборки у нас ошибки не будет.
Запустим после сборки код на выполнение и увидим, что целочисленные данные у нас никакие не выводится, как мы и задумали
Итак, на данном уроке мы научились пользоваться комментариями. Мы узнали когда и для чего какие виды их применяются. Пусть мы не написали сегодня никакого полезного кода, но, надеюсь, умение (и также привычка) писать комментарии у нас после данного занятия появилась.
Всем спасибо за внимание!
Предыдущий урок Программирование на C Следующий урок
Смотреть ВИДЕОУРОК (нажмите на картинку)
Спасибо за очередной урок.
Когда повторял Ваш предыдущий урок по выводу разных типов данных, поставил себе цель выполнять операции по созданию новой папки и копированию в нее «заготовки» из первого урока с помощью средств командной строки. Возился долго, но получил истинное удовольствие.