How to Write a Good Code Comment

Published

2020-04-20 10:00

Collected

2026-07-04 11:30

---
id: 3038
title: "How to Write a Good Code Comment"
source_domain: hackerone.com
source_url: "https://www.hackerone.com/blog/how-write-good-code-comment"
published_at: "2020-04-20T10:00:00Z"
tags: ["code-review", "best-practices", "software-development", "pullrequest", "code-comments", "clean-code"]
phying_url: "https://phying.com/item/3038"
lang: en
---

# How to Write a Good Code Comment

## Summary

PullRequest reviewer Tyler Adams explains what makes a good code comment: point out unusual code, state what is unusual, why it exists, and give readers context they couldn't infer otherwise.

## Intelligence Metadata

- **Sources:** hackerone.com
- **Published:** 2020-04-20T10:00:00Z
- **Original:** https://www.hackerone.com/blog/how-write-good-code-comment
- **Phying News:** https://phying.com/item/3038