Chỉ một lời bình

Lập trình R theo hướng phòng thủ

Colin Gillespie

Jumping Rivers

Tôi không biết bạn thế nào...

  • Mã hôm nay có vẻ rõ ràng
  • Vài tuần sau thường không còn rõ như vậy
Lập trình R theo hướng phòng thủ

Chú thích (comments)

  • Bạn có thể thêm chú thích vào mã R bằng #
  • Viết chú thích tốt không hề dễ!
# Đây là một chú thích
# Chú thích trên không hữu ích lắm
# Hay là có?
Lập trình R theo hướng phòng thủ

Mẹo 1: Tránh chú thích hiển nhiên

  • Cái “rõ ràng” đôi khi khó xác định
    • Ví dụ, các chú thích sau
       # Lặp qua các tập dữ liệu
 for (dataset in datasets) {
  # Đọc tập dữ liệu
  r <- read.csv(dataset)
 }
      trông hợp lý
    • Nhưng có lẽ quá hiển nhiên
Lập trình R theo hướng phòng thủ

Mẹo 2: Tránh chú thích bạn sẽ không cập nhật

Ví dụ phổ biến nhất là chú thích tiêu đề ở đầu tệp

# Cập nhật lần cuối: 1967-02-25
# Tác giả: D Law
# Trạng thái: Số 1
  • Kiểu chú thích này hầu như không bao giờ được cập nhật
  • Tôi từng thấy # danh sách gói dùng: XXX, YYY
Lập trình R theo hướng phòng thủ

Mẹo 3: Nhất quán

  • Luôn bắt đầu bằng một # hoặc hai ##
  • Viết hoa chữ cái đầu — tuân thủ ngữ pháp
  • Cẩn thận với trò đùa
    • Điều bạn thấy buồn cười có thể xúc phạm người khác
  • Nhớ chú thích đoạn mã “trông sai”
  • Dùng # TODO hoặc # XXX để đánh dấu việc cần làm sau
Lập trình R theo hướng phòng thủ

Ayo berlatih!

Lập trình R theo hướng phòng thủ

Preparing Video For Download...