Java模板Velocity模板编码规范

1、模板文件名称遵循类的命名规范，首字母小写，各单词首字母大写，其他字母小写的格式。
如：orderIntention.vm。

2、每个模板文件开头应该写上注释，说明该模板是展示那些数据，或者展示那个功能的。注释格式如下：
#######################
##注释内容
##注释内容
##注释内容
#######################

3、 模板中的变量名需要规范起来，变量名应该首字母小写，中间单词的首字母大写，其他字母小写的命名规范，比如：
变量名researchUrl为推荐形式，而research_url，ResearchUrl等都是不被推荐的形式；变量的名称最好能够见名知义，因此应该起一些有实际意义的单词，不建议使用单个字母作为变量
4、 模板中需要注意缩进，缩进格式是4各空格键（不使用tab），比如：
#if($testA)
    doSomeThingA()
#else
    #if($testB)
        doSomeThingB()
   #end
#end
严格的缩进能够清楚的展示哪个#end对应于哪个#if，让程序更加便于阅读和维护。

5、 尽可能让模板的逻辑代码和html代码脱离开，使模板代码更容易阅读。
6、 逻辑代码尽量写注释，以便增强逻辑代码的可读性。
7、 在模板中，变量名是很宝贵的资源，开发人员开发代码时，应该检查一下是否类似的变量已经存在，如果存在，就使用已有的变量，而不要再自己新造变量。（存在重复变量，比如OfferSearch.vm（拆分后变为SaleOfferSearch.vm）上的complexResult和searchResult，实际上值是一样的，但是使用了 两个变量名，这种情况也不推荐。应该尽量减少参数的名称，降低代码复杂度。）
8、 现在存在着好几个页面使用同一个变量的情况（变量代表的值是一样的），但是由于开发的人员和开发时间的不同，造成了这些变量在不同的页面里有不同的名字，这种情况要避免出现：开发人员开发的时候，需要有全局观念，在实现一些小需求时，最好能够对整个系统有所了解，了解系统中大部分的变量名，避免同一个变量在不同的页面叫不同的名字；同时，代码审核人员在审核代码时，也应该对这方面进行注意。
9、 参数输出和传递格式需要统一，在模板中需要输出变量时使用统一的格式，如：$!param；在设置参数的时候也使用统一格式，如：setParameter("param", $param);注意，在输出参数时必须加上感叹好"！"，否则当参数为空时，直接输出$!param。
10、页面上的img和js地址统一使用配置变量，不要写死在页面上，
如：
http://img.zjzx.com/xxx/xxx/xxx.gif，而应该使用$!imgServer/xxx/xxx/xxx.gif。
http://style. zjzx.com/xxx/xxx/xxx.css，应该使用$!styleServer/xxx/xxx/xxx.css。
11、页面上指向其他应用的地址也尽量使用配置的方式，
如：
http://shoppingcart.alpress.com/shopcart/shopcartDetail.htm，应该是这样的，$!shopcartServer/shopcart/shopcartDetail.htm。
shopcartServer在uri.xml文件中配置，这样做的方便模板的维护。

12、页面上的引入js文件的代码，统一放在页面的最底端，以加快页面加载速度。