Лише один коментар
Оборонне програмування R
Colin Gillespie
Jumping Rivers
Не знаю, як у вас...
- Код, який сьогодні очевидний
- За кілька тижнів часто вже не такий зрозумілий
Коментарі
- Ви можете додавати коментарі в R через
# - Насправді писати хороші коментарі складно!
# Це коментар
# Попередній коментар не дуже корисний
# А може, й корисний?
Порада 1: Уникайте очевидних коментарів
- Інколи важко вирішити, що є очевидним
- Наприклад, коментарі
виглядають доречно# Перебрати набори даних циклом for (dataset in datasets) { # Прочитати набір даних r <- read.csv(dataset) } - Але, можливо, вони надто очевидні
- Наприклад, коментарі
Порада 2: Уникайте коментарів, які ви не оновлюватимете
Найтиповіший приклад — шапка-коментарі на початку файлу
# Останнє оновлення: 1967-02-25
# Автор: D Law
# Статус: No 1
- Такі коментарі майже ніколи не оновлюють
- Якось я бачив
# list of packages used: XXX, YYY
Порада 3: Будьте послідовні
- Завжди починайте з одного
#або двох## - Починайте з великої літери — дотримуйтеся граматики
- Обережно з жартами
- Те, що смішно вам, інших може образити
- Обов'язково коментуйте код, який «виглядає підозріло»
- Використовуйте # TODO або # XXX для позначення майбутньої проблеми
Давайте потренуємось!
Оборонне програмування R
