Россия и Беларусь начали и продолжают войну против народа Украины!

Комментарии в R

  Акод  | 

  |

  Обновл. 21 Май 2023  | 

 136

Комментарии — это описания в коде, которые помогают всем, кто читает, лучше понять, что и зачем делает код. Например:

Здесь следующие строки являются комментариями:

   # Инициализация переменной

   # Вывод переменной на экран

Комментарии не имеют никакого отношения к логике кода. Они не интерпретируются и не компилируются, и полностью игнорируются во время выполнения программы.

Типы комментариев в R

Как правило, в программировании существуют 2 основных типа комментариев:

   однострочные;

   многострочные.

Однако в языке R нет многострочных комментариев, только однострочные.

Однострочные комментарии

Для создания однострочных комментариев в R используется символ #. Например:

Результат:

[1] "Hello, World!"

Здесь мы использовали однострочный комментарий с помощью символа #.

Примечание: Однострочный комментарий можно писать и на одной строке с кодом, а точнее после него. Например:

Многострочные комментарии

Как уже упоминалось, в R нет синтаксиса для создания многострочных комментариев. Однако можно использовать последовательные однострочные комментарии для создания многострочного комментария в R. Например:

Результат:

[1] "Hello, World!"

Здесь мы использовали несколько последовательных однострочных комментариев, чтобы создать многострочный комментарий прямо перед функцией print().

Зачем нужны комментарии?


   Документирование отдельных частей кода, например, переменных, функций, блоков кода. Это помогает другим разработчикам понять работу написаного кода.

   Улучшение читаемости и понимания кода другими разработчиками.

   Предоставление метаданных о коде или общем проекте.

   Игнорирование или «выключение» некоторых частей кода во время тестирования или отладки.

Как писать качественные комментарии?

Среди задач программистов числится не только написание эффективного кода, но и чтение кода, написанного другими разработчиками, а также внесение изменений в «чужой» код. В таком случае хорошо написанный комментарий может сэкономить немало времени.

При написании комментариев важно учитывать следующие моменты:

   На уровне библиотек/программ/функций оставляйте комментарии, отвечая на вопрос «ЧТО?».

   Внутри библиотек/программ/функций оставляйте комментарии, отвечая на вопрос «КАК?».

   На уровне стейтментов оставляйте комментарии, отвечая на вопрос «ПОЧЕМУ?».

   Не злоупотребляйте комментариями. Желательно делать код «самоописательным» (например, путем подбора корректных имен для переменных и функций).

   Не пишите слишком много комментариев.


Оценить статью:

Звёзд: 1Звёзд: 2Звёзд: 3Звёзд: 4Звёзд: 5
Загрузка...

Добавить комментарий

Ваш E-mail не будет опубликован. Обязательные поля помечены *