Jindent - Java Source Code Formatter http://www.jindent.com
 

previous topic  Previous:  Comments Next:  Statements   next topic

title
5.6.1.8.3 JavaDocs

Blank lines before JavaDocs

Blank lines before JavaDocs

Sets number of blank lines before JavaDoc comments.

JavaDoc comments are from type /** ... */ and can contain a single or muliple lines.


Set 1 blank line before JavaDoc comments:

                                       
/**                                     
 * Calculates something.                
 *                                      
 * @param i   value i                   
 */                                     
public void test(int i)                 
{                                       
    ...                                 
}                                       


Set 2 blank lines before JavaDoc comments:

                                       
                                       
/**                                     
 * Calculates something.                
 *                                      
 * @param i   value i                   
 */                                     
public void test(int i)                 
{                                       
    ...                                 
}                                       



Blank line after JavaDocs

Blank line after JavaDocs

Sets number of blank lines after JavaDoc comments.


Set 1 blank line after JavaDoc comments:

/**                                     
 * Calculates something.                
 *                                      
 * @param i   value i                   
 */                                     
                                       
public void test(int i)                 
{                                       
    ...                                 
}                                       


Set 1 blank line before and after JavaDoc comments:

                                       
/**                                     
 * Calculates something.                
 *                                      
 * @param i   value i                   
 */                                     
                                       
public void test(int i)                 
{                                       
    ...                                 
}