Login | Register   
LinkedIn
Google+
Twitter
RSS Feed
Download our iPhone app
TODAY'S HEADLINES  |   ARTICLE ARCHIVE  |   FORUMS  |   TIP BANK
Browse DevX
Sign up for e-mail newsletters from DevX


Tip of the Day
Language: Java
Expertise: Beginner
Nov 19, 1998

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 (<P>), bold (<B>) and italic (<I>) tags to generate more readable documentation which directs the reader's attention to the important information. For instance:
 
/**
 *  This is the first paragraph.<p>
 *  This is the second paragraph.<p>
 *  <B><I>I'd really like to emphasize this point.</I></B>
 */
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.

Brett Spell
 
Comment and Contribute

 

 

 

 

 


(Maximum characters: 1200). You have 1200 characters left.

 

 

Sitemap
Thanks for your registration, follow us on our social networks to keep up-to-date