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.

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

Overview

The Latest

technology leadership

Why the World Needs More Technology Leadership

As a fact, technology has touched every single aspect of our lives. And there are some technology giants in today’s world which have been frequently opined to have a strong influence on recent overall technological influence. Moreover, those tech giants have popular technology leaders leading the companies toward achieving greatness.

iOS app development

The Future of iOS App Development: Trends to Watch

When it launched in 2008, the Apple App Store only had 500 apps available. By the first quarter of 2022, the store had about 2.18 million iOS-exclusive apps. Average monthly app releases for the platform reached 34,000 in the first half of 2022, indicating rapid growth in iOS app development.

microsoft careers

Top Careers at Microsoft

Microsoft has gained its position as one of the top companies in the world, and Microsoft careers are flourishing. This multinational company is efficiently developing popular software and computers with other consumer electronics. It is a dream come true for so many people to acquire a high paid, high-prestige job

©2023 Copyright DevX - All Rights Reserved. Registration or use of this site constitutes acceptance of our Terms of Service and Privacy Policy.

Sitemap