In Apache Velocity, the # character is used to indicate the start of a directive (e.g., #if, #foreach). If you want to include a literal # in your output without it being interpreted as a directive, you need to escape it.
Ways to Escape a # in Velocity:
1. Using a Backslash (\)
You can escape the # by preceding it with a backslash (\). The backslash tells Velocity to treat the # as a literal character.
Example:
This is a literal hash symbol: \#
Output:
This is a literal hash symbol: #
2. Using the \ Escape Mechanism in a String
If the # is inside a string, ensure you escape it using \.
Example:
#set($message = "This is a hash symbol: \#")
$message
Output:
This is a hash symbol: #
3. In Escaping Scenarios with Variables
If you have a # in a variable or output and you want to ensure it renders as a literal:
Example:
#set($hash = "\#")
This is a hash symbol: $hash
Output:
This is a hash symbol: #
Notes:
- If you mistakenly leave the
#unescaped and it doesn’t match any valid directive, Velocity will likely throw a parsing error. - Use
\to escape consistently, especially when combining strings or variables with literal#symbols.
Let me know if you’d like further assistance!