代码命名规范

代码命名规范：

• Form的前缀，固定为3个字母，第1个字母大写，固定为Frm， app-forms.xml中formId的命名，应与Form类名保持一致

• Service的前缀，固定为3个字母，第1个字母大写，固定为Svr， app-services.xml中serviceId的命名，应与Service类名保持一致。

• 相类似的服务，一般一个serviceId对应一个class。适当允许多个serviceId对应一个class（高内聚）。

• servieId可以使用小圆点作业分隔符，以区分同系列的服务，如： SvrUserInfo.addAccount, SvrUserInfo.updateAccount, SvrUserInfo.updatePassword，其相应的class为SvrUserInfo_addAccount, SvrUserInfo_updateAccount，SvrUserInfo_updatePassword。

• 每个formId、serviceId，均应具有全局（整个项目）的查找唯一性，不当的命名如： SvrUpdateInfo.update + SvrUserInfo.updatePassword：当我们使用 SvrUpdateInfo.update 搜索时，同时搜索出 SvrUserInfo.updatePassword，这会导致我们代码重构困扰。

• jsp文件所在的相对目录路径，应该与form的包路径保持一致性，以便其它人员接手时，快速定位。

• jsp文件的文件名，应与formId + pageCode一致，如：

//formId: FrmCity
public class FrmCity extends AbstractForm{
    //pageCode: step2
	public IPage step2(){
	    //jsp file: FrmCity_step2
		JspPage page = new JspPage(this, "FrmCity_step2.jsp");
	}
}

• 若某js为某jsp文件专用，则该js文件应该放到与jsp相对目录一样的静态文件夹，且其命名应与jsp文件保持一致。

最后更新日期：2016/10/18