DEV Community

Discussion on: What little things make you happy while coding?

Collapse
 
6temes profile image
Daniel • Edited

There are comments and comments. The comments explaining what the code does are usually a symptom that the code is convoluted and difficult to understand even for the person who is writing it.

On the other hand, there are comments like:

# This solves a bug in the library Fubar that prevented the Baz 
# from being executed. See: https://github.com/fu_bar/baz/issues/454

Or:

# Temporalirly removed as per request in Issue #1243

Those make perfect sense to me.

Thread Thread
 
slavius profile image
Slavius • Edited

Works very well in commit messages when you have Bitbucket integrated with Jira. Hell of a difference!