댓글 하나만

방어적 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...