Add Documentation to Identify Sections in Your Code

With embedded combinations of loops, conditions, and try / catch statements, it can be difficult to keep track of where each section ends when quickly scanning your Java code, even with the help of indention. For example:

 public method doSomething(Object value) {	int value;	if (value instanceof String) {		try {			value = Integer.parseInt(value.toString());		}		cach (NumberFormatException nfe) {			value = -1;		}	}	else if (value instanceof Integer) {		value = ((Integer)value).intValue();	}}

With complex combinations, these blocks are not only difficult to separate visually, but they can also be difficult to debug if you accidentally omit a closing brace. The situation can be improved by adding documentation that identifies the end of a given section:

 public method doSomething(Object value) {	int value;	if (value instanceof String) {		try {			value = Integer.parseInt(value.toString());		}  //  try		cach (NumberFormatException nfe) {			value = -1;		}  //  catch (NumberFormatException nfe)	}  //  if (value instanceof String)	else if (value instanceof Integer) {		value = ((Integer)value).intValue();	}  //  else if (value instanceof Integer)}  //  public method doSomething(Object value)

This technique is especially helpful for very long blocks of code, where the closing brace does not appear on the screen at the same time (or same page of a printout). The programmer can then easily identify the beginning and end of a section of code by using a combination of indention and the comment describing the start of the section.

Share the Post:
Share on facebook
Share on twitter
Share on linkedin


The Latest

homes in the real estate industry

Exploring the Latest Tech Trends Impacting the Real Estate Industry

The real estate industry is changing thanks to the newest technological advancements. These new developments — from blockchain and AI to virtual reality and 3D printing — are poised to change how we buy and sell homes. Real estate brokers, buyers, sellers, wholesale real estate professionals, fix and flippers, and beyond may

man on floor with data

DevX Quick Guide to Data Ingestion

One of the biggest trends of the 21st century is the massive surge in internet usage. With major innovations such as smart technology, social media, and online shopping sites, the internet has become an essential part of everyday life for a large portion of the population. Due to this internet

payment via phone

7 Ways Technology Has Changed Traditional Payments

In today’s digital world, technology has changed how we make payments. From contactless cards to mobile wallets, it’s now easier to pay for goods and services without carrying cash or using a checkbook. This article will look at seven of the most significant ways technology has transformed traditional payment methods.