Só um comentário

Programação Defensiva em R

Colin Gillespie

Jumping Rivers

Eu não sei você...

  • Código que hoje é óbvio
  • Em poucas semanas costuma não ser tão óbvio assim
Programação Defensiva em R

Comentários

  • Você pode adicionar comentários ao seu código R com #
  • Escrever bons comentários é mais difícil do que parece!
# Este é um comentário
# O comentário acima não é muito útil
# Ou é?
Programação Defensiva em R

Dica 1: Evite comentários óbvios

  • O que é óbvio às vezes é difícil de decidir
    • Por exemplo, os comentários
       # Percorrer conjuntos de dados
 for (dataset in datasets) {
  # Ler conjunto de dados
  r <- read.csv(dataset)
 }
      parecem razoáveis
    • Mas talvez sejam óbvios demais
Programação Defensiva em R

Dica 2: Evite comentários que você nunca vai atualizar

O exemplo mais comum são comentários de cabeçalho no topo do arquivo

# Última atualização: 1967-02-25
# Autor: D Law
# Status: Nº 1
  • Esse tipo de comentário quase nunca é atualizado
  • Já vi # lista de pacotes usados: XXX, YYY
Programação Defensiva em R

Dica 3: Seja consistente

  • Sempre comece com um único # ou duplo ##
  • Comece com letra maiúscula — siga as regras de gramática
  • Cuidado com piadas
    • O que é engraçado para você pode ofender outros
  • Comente código que "parece errado"
  • Use # TODO ou # XXX para indicar um problema futuro
Programação Defensiva em R

Vamos praticar!

Programação Defensiva em R

Preparing Video For Download...