Style

Lets you control the style of separator comments.

Fill character

Lets you define the fill character that should be used in comments.

Example 2.733. Fill character styles

//~ Methods

//~ Methods ............................................................

//~ Methods ------------------------------------------------------------

//~ Methods ============================================================

//~ Methods ************************************************************

//~ Methods ////////////////////////////////////////////////////////////

Edit...

Press the Edit... button to adjust the templates that will be used for separator comments. The templates may contain one or several single-line or multi-line comments. You can configure two different templates: one for the comments between the different declaration sections, and one for comments between method declarations.

Example 2.734. Default separator template

//~ ${description} ${fill.character}*

As you can see in the example above, certain variables may be used that are substituted during formatting to include the code section description or stretch the comment to completely fill a line.

Table 2.6. Separator template variables

VariableDescription
${description} Lets you include the description text of the current code section (Refer to the section called “Separator Comment Descriptions” for information on how to adjust the descriptions).
${fill.character} Lets you include the fill character as defined by the corresponding combo box. Please note that you have to place an asterix (*) after the variable if you want to have a comment line stretched to the full line length.

Please note that Jalopy needs a way to differ between user comments and separator comments, because separator comments must be removed on each run in order to ensure correct locations and behavior. Jalopy recognizes all single-line comments starting with //~ as separator comments. If you would rather use a multi-line comment instead or don’t like the default identifier, you need to make sure that the comments get removed. This means can be achieved by adding a unique identifier into the template and configure a custom removal pattern for it (see the section called “Comment Removal”).

Example 2.735. Multi-line comment separator template

/**${fill.character}*
 *    ~#~       ${description}:
 *${fill.character}*/

In the example above, ~#~ would be configured as the removal pattern.

Since 1.4

Line length

Lets you define the maximal line length for separator comments. The specified fill character might be used to increase the length of a separator comment to span exactly until the specified line length.

Since 1.2.1