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



title
5.6.1.15 Notes

A note is a comment containing a short information.
Note comments always start with the prefix //~ so that Jindent is able to recognize and remove already inserted note comments from previous Jindent sessions.



title
5.6.1.15.1 Code Convention

A code convention note is a short comment containing a description about the used code convention.

Note

Note

Defines template for code convention note.



For instance we assume a template like:

Formatted in $conventionName$ on $date$ 

And setting "Position" is set to bottom and "Separated by blank lines" has value 2.

An output could look like:

package mypackage;                      
                                       
public class MyClass                    
{                                       
    ...                                 
}                                       
                                       
                                       
//~ Formatted in Sun Code Convention on 2005-02-10

In this case we used environment variables conventionName and date. For more details about environment variables please refer to topic 'Environment Variables' and to section 'templates' in topic 'JavaDocs'.

See also... See also: Jindent - Settings - Environment - Environment Variables - Special Variables , Jindent - Settings - Formatter - Java / SQLJ - JavaDocs - Templates




Position

Position

Disables and enables insertion of code convention note at top or bottom of source code.



Separated by blank lines

Separated by blank lines

Number of blank lines to separate code convention note from other source code elements.