Только один комментарий

Защитное программирование на R

Colin Gillespie

Jumping Rivers

Знакомая ситуация?

  • Код, который сегодня кажется понятным
  • Через несколько недель часто оказывается не таким очевидным
Защитное программирование на R

Комментарии

  • Комментарии в R добавляются с помощью #
  • Писать хорошие комментарии — не так просто!
# This is a comment
# The above comment isn't very helpful
# Or is it?
Защитное программирование на R

Совет 1: избегайте очевидных комментариев

  • Определить, что очевидно, бывает непросто
    • Например, комментарии
       # Loop through data sets
 for (dataset in datasets) {
  # Read in data set
  r <- read.csv(dataset)
 }
      выглядят разумно
    • Но, пожалуй, слишком очевидны
Защитное программирование на R

Совет 2: не пишите комментарии, которые не будете обновлять

Чаще всего это заголовочные комментарии в начале файла

# Last updated: 1967-02-25
# Author: D Law
# Status: No 1
  • Такие комментарии почти никогда не обновляются
  • Однажды встречалось: # list of packages used: XXX, YYY
Защитное программирование на R

Совет 3: будьте последовательны

  • Всегда начинайте с одного # или двух ##
  • Пишите с заглавной буквы — соблюдайте правила грамматики
  • Осторожнее с шутками
    • То, что кажется вам смешным, другие могут воспринять иначе
  • Комментируйте код, который «выглядит неправильно»
  • Используйте # TODO или # XXX для обозначения будущих задач
Защитное программирование на R

Давайте потренируемся!

Защитное программирование на R

Preparing Video For Download...