Skip to content

Module 2: Roxygen Documentation 📖

📝 Stats

  • Số lượng: 5 câu hỏi
  • Độ khó: Dễ

MCQ

Q1. Tag rroxygen nào quyết định hàm có được người dùng nhìn thấy (public) hay không?

  • [ ] @visible
  • [ ] @public
  • [ ] @export
  • [ ] @function

Đáp án: @export. (Thiếu cái này thì hàm là internal/private).

Q2. Sau khi sửa comment Roxygen, bạn phải chạy lệnh gì để cập nhật file .RdNAMESPACE?

  • [ ] devtools::check()
  • [ ] devtools::document()
  • [ ] devtools::load_all()
  • [ ] devtools::install()

Đáp án: devtools::document().


Coding Challenge

Challenge: Documenting a Function

Viết block Roxygen hoàn chỉnh cho hàm hello(name) trả về chuỗi "Hello Name". Yêu cầu: Có Title, Description, Param, Return, Export và Example.

r
#' Say Hello
#'
#' Hàm này chào người dùng bằng tên.
#'
#' @param name Chuỗi ký tự. Tên người cần chào.
#' @return Một chuỗi ký tự dạng "Hello [name]".
#' @export
#' @examples
#' hello("Tom")
hello <- function(name) {
  paste("Hello", name)
}