Javashop开发规范V4.0.docxVIP

1.命名规范21.1.包命名规范21.2.类名命名规范21.3.变量/属性命名规范31.4.方法命名规范31.4.1.Controller类命名规范31.4.2.业务类命名规范41.5.CSS命名规范51.5.1.文件名称规范51.5.2.样式命名规范51.6.Javascript命名规范51.6.1.文件名称规范51.6.2.变量、对象、函数、实例、类命名规范51.7.HTML命名规范61.7.1.文件名称规范61.7.2.HTML结构名称规范62.注释规范62.1.包名注释规范62.2.类注释72.3.属性注释72.4.方法外部注释72.5.方法内部注释82.6.CSS注释规范92.6.1.文件注释92.6.2.模块注释92.6.3.样式注释92.7.HTML注释规范102.8.Javascript注释规范102.8.1.文件注释102.9.Freemarker注释规范112.9.1.方法外部注释112.9.2.方法内部注释123.Svn目录规范123.1.目录结构124.数据库变更规范135.后台界面规范145.1.信息输入页（包括添加和修改）145.2.列表页155.2.1.列表及简单搜索155.2.2.高级搜索155.2.3.详细页中的列表156.商品价格规范156.1.freemarker166.2.javascript167.常用字典对照表167.1.常用值167.2.常用名称17Javashop开发规范命名规范包命名规范小写字母以com.enation.javashop开头组件以poent开头类名命名规范通用规范只能以字母、数字命名不能出现下划线、中横线开头字母必须大写名称如果是词组，采用驼峰命名法如“我的优惠卷列表标签”：MyCouponListTagController类以Controller结尾，如：UserControllerAPIControlle类业务名称+API+Controller标签类以Tag结尾，如BuyerOrderListTag业务类1.接口：以I开头，以Manager结尾，如：IUserManager2.实现类以Manager结尾，如:UserManager组件类以Component结尾，如：ShopEmailComponent插件类以Plugin结尾，如：SendRegMailPlugin变量/属性命名规范可由字母和数字、下划线组成首字母必须小写除bean依赖的属性外，必须全部小写方法命名规范Controller类命名规范A方法命名只能以字母、数字命名不能出现下划线、中横线开头字母必须小写名称如果是词组，采用驼峰命名法add到添加页edit到修改页saveAdd保存添加saveEdit保存修改delete删除list列表listJson列表的jsonB访问路径命名路径中方法名：基本原则为将驼峰命名改为以中横线连接，将驼峰的大写母小写，注意不能以下划线连接，如listJson，则访问路径为：list-jsonAPI路径规范：/api/应用名路径/业务名/方法名.do后台Controller访问路径：/应用名路径/admin/业务名/方法名.do业务类命名规范只能以字母、数字命名不能出现下划线、中横线开头字母必须小写名称如果是词组，采用驼峰命名法add添加edit修改delete删除list列表get读取详细CSS命名规范文件名称规范只能以字母、数字、中横线命名（不能出现下划线）字母全部小写样式命名规范只能以字母、数字、中横线命名（不能出现下划线）字母全部小写更多规则参考：《Javashop CSS框架规范》(待书写)Javascript命名规范文件名称规范只能以字母、数字、中横线命名（不能出现下划线）字母全部小写变量、对象、函数、实例、类命名规范以小写字母开头，驼峰式命名变量命名不要使用保留字不能出现下划线、中横线创建构造函数、类首字母必须大写私有变量命名需要以下划线”_”开头更多规则参考：《Javashop JavaScript框架规范》(待书写)HTML命名规范文件名称规范只能以字母、数字、中横线命名（不能出现下划线）字母全部小写HTML结构名称规范HTML中所有标签、类名、属性等等必须使用小写注释规范包名注释规范包中必须存在注释文件：package.html ，用于负责package.html内容规范：html?body?p一句话简述。?/pp详细描述。?/pp产品模块名称和版本?br /公司版权信息?/p/body?/html?示例：类注释应放在package关键后，class或interface关键字之前应使用/**开头应包含以下说明项：功能描述，@author(作者)，@version（版本号）,@since（此功能开发时的产品版本号），开发时间属性注释应以/**开头应紧