Adding comments

Learn to add line comments to a PR.

What is an inline comment?

During a GitHub Pull Request review, you can add a comment directly to a specific code line. This comment is not just a general message; it is linked to the relevant line and clearly shows where the issue is located.

function divide(a, b) {
    return a / b;
}

For example, if you notice a possible division by zero, you can leave a comment directly on the return a / b; line.

Adding comments and suggestions

In a line comment, you can explain an issue and suggest how the code should be changed. GitHub also provides a suggestion feature in its supported review interface that allows proposed code changes to be applied directly.

// Suggested validation
if (b === 0) {
    throw new Error("Cannot divide by zero");
}

Keep comments concise, clear, and solution-oriented.

Exercise Create inline comment data

Create an object named comment. Set line to 8, type to "inline", and suggestion to "Add validation". Print the suggestion using console.log.

Show example solution

const comment = {
    line: 8,
    type: "inline",
    suggestion: "Add validation"
};

console.log(comment.suggestion);

Test yourself

Which type of comment is used to provide direct feedback on a code line?
- Commit message
- Repository description
- Inline comment
- General PR description
Show answer

Inline comment — An inline comment is attached to a specific code line in a Pull Request.

Specify the comment type

const comment = {
    line: 12,
    type: "____"
};

Show answer

const comment = {
    line: 12,
    type: "inline"
};

PR comment features

Inline

Attached to a specific line
Comment

A feedback message
Suggestion

A proposed code change
Line

A line of code

Next lesson: Approving

We Are Enhancing Your Experience

Cookie Preferences

Strictly Necessary Cookies

Analytical Cookies