Phil Eaton 9/7/2020

The case for comments in code

Read Original

The article details the author's evolution from a beginner who wrote redundant comments, to a proponent of self-documenting code, and finally to an advocate for strategic inline comments. The key argument is that while pull request descriptions and comments are useful for reviewers, they become difficult to search and access over time. Inline code comments are presented as the most durable and searchable form of documentation for future developers encountering oddities, workarounds, or complex logic.

The case for comments in code

Comments

No comments yet

Be the first to share your thoughts!

Browser Extension

Get instant access to AllDevBlogs from your browser

Top of the Week