devxlogo

When Writing javadoc-style Comments Use HTML Tags to Improve Readability

When Writing javadoc-style Comments Use HTML Tags to Improve Readability

When writing javadoc-style comments, use HTML tags to improve the readability of the generated documented. For example:

 /** *  This is the first paragraph. *  This is the second paragraph. *  I'd really like to emphasize this point. */

produces:

 This is the first paragraph. This is the second paragraph. I'd really like to emphasize this point.

Instead, use HTML tags such as the paragraph separator (

), bold () and italic () tags to generate more readable documentation whichdirects the reader’s attention to the important information. Forinstance:

 /** *  This is the first paragraph.

* This is the second paragraph.

* I'd really like to emphasize this point. */

Produces:

 This is the first paragraph.

This is the second paragraph.

I'd really like to emphasize this point.

This technique will make your documentation look more professional, as well as make it easier to read and find the key pieces of information.

devx-admin

Share the Post: