一、模板注释区分
| 写法 | 类型 | 特点 |
|---|---|---|
<!-- HTML注释 --> | HTML原生注释 | 会输出到最终网页源码,浏览器查看源代码能看到 |
## 单行注释 | Velocity单行注释 | 仅引擎识别,不会输出到页面,生效至本行末尾 |
#* 多行注释内容 *# | Velocity多行注释 | 支持跨越多行,不会输出到页面 |
开发建议:业务说明代码注释优先使用
##/#* *#,避免页面源码泄露注释信息。
二、变量命名规则
官方命名基础规则
- 变量首字符必须是英文字母(a-z / A-Z)
- 后续字符允许:字母、数字
0-9、下划线_、减号-
减号 - 存在运算符歧义
#set($name-d = "test")Code language: PHP (php)
执行时会报截图错误:Encountered "name" ... Was expecting one of:
原因:Velocity把 - 识别为减法运算符!
引擎解析逻辑:$name - d,误认为是变量$name减去变量d,语法直接冲突。
两种解决方案:
- 推荐:改用下划线命名(无歧义,通用规范)
#set($name_d = "hello world")Code language: PHP (php)
- 大括号限定变量边界(兼容带减号名称)
#set(${name-d} = "hello world")
${name-d}Code language: PHP (php)
合法/非法示例对照
# ✅合法
#set($name_d = "下划线")
#set($name12d = "字母开头+数字")
#set(${name-1_2d} = "带减号必须加大括号")
# ❌直接写减号,不加大括号 → 解析报错
#set($name-d = "报错!")
#set($name-1_2d = "报错!")Code language: PHP (php)
三、#set 语法书写规范
标准写法(括号前后空格可灵活,建议统一风格)
#set($变量名 = "值")Code language: PHP (php)
字符串必须使用双引号包裹;等号左右建议保留空格,可读性更好。