Over a million developers have joined DZone.

Best Practices for Commenting Code

DZone's Guide to

Best Practices for Commenting Code

· Java Zone
Free Resource

Just released, a free O’Reilly book on Reactive Microsystems: The Evolution of Microservices at Scale. Brought to you in partnership with Lightbend.

Adding comments to code is an important part of writing Java programs. Though it is recommended to add as many comments as possible in your code but still there are some best practices which if followed really make code commenting a useful affair not only for the developer himself but also fellow developers.

Here in this tutorial, I will list down some tips and guidelines for writing the code comments in a Java program:

  1. Add comments for each ending block so that it is clear which code block is going to end.
    if (abc==xyz)
    for(...) {
    } //for
    } //if
    } //while
  2. Format the comments so that they are properly aligned and break to next line if exceed the viewable area. This helps in getting rid of extra scrolling just to view the comments.
  3. Use proper language and avoid frustating comments like:
        //Finally got it
       //you can't escape from me
  4. Comment out the code which could be reused in future but could not be implemented this time.
  5. Focus on why part of the code and explain the need of code you are going to write.
  6. Usually the bug id is also added when you are working on some enhancement/bug so that other developers can get the need for the code.

Strategies and techniques for building scalable and resilient microservices to refactor a monolithic application step-by-step, a free O'Reilly book. Brought to you in partnership with Lightbend.


Published at DZone with permission of Sandeep Bhandari. See the original article here.

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}