Skip to main content

Command Palette

Search for a command to run...

Code Review Comments

Updated
1 min read
Code Review Comments
S

I love learning about technology and sharing that with others

Motivation

  • These are the comments received to me during my code review and I really loved them since it will improve my understanding of the code :)

Comments Received During PR Review

  1. Use constants instead of String litterals to compare anything
  2. Use meaningful names of the variables
  3. Add the comments before function declaration

    1. these comments are documenting comments
    2. documenting comments : describe the semantics of the class field and method
    3. Good documenting comments allows you to read and use that particular class or method without reading the implementation
  4. Add the implementation comments on : internal working

    1. add them only necessary

More from this blog

H

hashcodehub

271 posts

Consistent, Passionate and Organized :)