R/Comment.R

In stackoverflow: Stack Overflow's Greatest Hits

#' Multi-line Comments
#' 
#' @param ... comment, not evaluated.
#' 
#' @examples
#' Comment( `
#' 
#' # Put anything in here except back-ticks.
#'
#' api_idea <- function() {
#'   return TRUE
#' }
#' 
#' # Just to show api_idea isn't really there...
#' print( api_idea )
#' 
#' `)
####
#' 
#' @export
#' @author \href{http://stackoverflow.com/users/173985/thell}{Thell},
#' \href{http://stackoverflow.com/users/211116/spacedman}{Spacedman}
#'   Neal Fultz
#' @references \url{http://stackoverflow.com/questions/1231195/multiline-comment-workarounds}
Comment <- function(...) {invisible()}