Freebok   Guestbook   Home   
|  Site  |  Users  |  Help  | 

Velocity guide 3: Comments


Comments allows descriptive text to be included that is not placed into the output of the template engine. Comments are a useful way of reminding yourself and explaining to others what your VTL statements are doing, or any other purpose you find useful. Below is an example of a comment in VTL.

A single line comment begins with end of the line. If you're going to write a few lines of commentary, there's no need to have numerous single line comments. Multi-line comments, which begin with , are available to handle this scenario.

This is text that is outside the multi-line comment.
Online visitors can see it.

Here is text outside the multi-line comment; it is visible.

Here are a few examples to clarify how single line and multi-line comments work:

This text is visible. This text is visible.
This text is visible.  This text is outside
the comment, so it is visible.

There is a third type of comment, the VTL comment block, which may be used to store such information as the document author and versioning information:

This information has been taken from the Velocity User Guide (c) Velocity Documentation Team.