DEV Community


Discussion on: How To Write Comments

aakatev profile image

Agree with everything except for number 4. If your code has bug/unexpected behavior it should be documented in comments. Creating a GitHub issue or Jira tickets is definitely beneficial, but there is no guarantee the other developers will look at external sources while working on the code.

muhimen123 profile image
Muhimen Author

Yeah, I always had a doubt either to put that or not. decided to let you guys do the choice for me. 😊