R Comments

A comment is a line in your code that R completely ignores when running the program. Comments exist only for humans — to explain what the code does, why a particular approach was chosen, or to leave reminders for yourself and others who read the code later.

Why Comments Matter

Imagine writing a complex data analysis script, closing it, and returning six months later. Without comments, understanding your own code feels like reading a stranger's notes. Comments make your code readable, maintainable, and professional.

Without Comments:              With Comments:
────────────────               ─────────────────────────────────
x <- 1.8                      height_m <- 1.8   # height in meters
y <- 75                       weight_kg <- 75   # weight in kilograms
z <- y / (x^2)                bmi <- weight_kg / (height_m^2)  # BMI formula
print(z)                       print(bmi)        # display result

The right side is immediately understandable. The left side requires guessing.

How to Write a Comment in R

In R, every comment starts with the # symbol (hash or pound sign). Anything on the same line after # is a comment and R ignores it completely.

# This is a full-line comment
print("Hello")   # This is an inline comment

Output:

[1] "Hello"

R ran the print("Hello") part and skipped everything after the # symbol on both lines.

Types of Comments

Single-Line Comment

A comment that occupies its own line. Use these to explain a block of code before it starts.

# Calculate the area of a rectangle
length <- 10
width <- 5
area <- length * width
print(area)

Inline Comment

A comment placed at the end of a code line. Use these to clarify a specific value or operation.

tax_rate <- 0.18   # GST rate in India (18%)
price <- 500
final_price <- price + (price * tax_rate)  # price including tax
print(final_price)

Block Comment (Multiple Lines)

R does not have a built-in multi-line comment syntax. To write a block comment, put a # at the start of each line.

# ─────────────────────────────────────────
# Script: Sales Analysis
# Author: Study Team
# Date: 2024
# Purpose: Analyze monthly sales figures
# ─────────────────────────────────────────

sales <- c(4500, 5200, 4800, 6100)
print(mean(sales))

Commenting Out Code Temporarily

When you want to test a script without running a specific line, add a # in front of it. This "comments it out" — the line stays in your file but R skips it.

total <- 100
discount <- 20
# discount <- 30    # testing an alternative discount
final <- total - discount
print(final)

Output:

[1] 80

The line with the 30% discount is skipped. This technique is very common during development and debugging.

Keyboard Shortcut to Comment/Uncomment

In RStudio, select one or more lines and press:

• Ctrl + Shift + C on Windows/Linux
• Cmd + Shift + C on Mac

This adds or removes the # symbol from the beginning of all selected lines at once. This shortcut saves a lot of time when managing larger scripts.

Good Comment Practices

Good Comments                         Bad Comments
──────────────────────────────────    ─────────────────────────────
# Calculate annual salary             # multiply x by 12
annual <- monthly * 12               annual <- monthly * 12

# Remove rows with missing values     # use na.omit
clean_data <- na.omit(data)          clean_data <- na.omit(data)

Good comments explain why or what, not just repeat what the code already says. "Multiply x by 12" adds nothing if the code already shows monthly * 12. "Calculate annual salary" tells you the purpose.

Section Dividers in Scripts

Long scripts benefit from visual dividers that separate different sections. In RStudio, lines ending with four or more dashes or equal signs after a comment become collapsible sections in the editor.

# SECTION 1: Load Data ────────────────────────
data <- read.csv("sales.csv")

# SECTION 2: Clean Data ────────────────────────
clean_data <- na.omit(data)

# SECTION 3: Analyze Data ──────────────────────
mean_sales <- mean(clean_data$sales)

These sections appear as collapsible arrows in RStudio's editor, making long scripts much easier to navigate.

Comments in Shared and Team Projects

When multiple people work on the same R scripts, comments become essential for team communication. Always include the author name, date, and a brief description at the top of any shared script. When you change existing code, add a comment explaining what you changed and why.

Comments cost zero computing power — R ignores them completely at runtime. Adding them generously is always a good habit and costs you nothing in performance.