如果需要的配置文件找不到,应用程序需能自己创建使用默认值。如果在配置文件中发现错误值,应用程序要抛出错误,给出提示消息告诉用户正确值。错误消息需能帮助用户解决问题。
注释
别每行代码,每个声明的变量都做注释。在需要的地方注释。
可读性强的代码需要很少的注释,如果所有的变量和方法的命名都很有意义,会使代码可读性很强并无需太多注释。行数不多的注释会使代码看起来优雅。
如果因为某种原因使用了复杂艰涩的原理,必须为程序配备良好的文档和详细的注释。
对注释做拼写检查,保证语法和标点符号的正确使用。
二、数据库设计规范
表格分类与命名
数据表的分类
系统表 支撑业务模型的数据表,如流程模型、系统管理相关表。
业务表 产品提供的针对业务的通用功能模块相关表,如通用业务查询等。
用户表 用户二次开发使用的与具体业务相关的数据表。
数据表的命名
所有表格命名一律以字母“T”开头(Table),并且用实义单词以下划线“_”间隔。
系统表 系统表前缀为:TSYS_
业务表前缀为:TBIZ_
用户表由用户自行定义,但是建议不要与系统表和业务表的命名规则重复。
字段的命名
字段的命名规则参照代码标识符的命名规则,但是注意避开数据库的保留字。比如不要采用这样的字段名:index,field,password,id,Oracle,SQL等等。
对于涉及到技术核心的系统表,为了防止剖析,建议采用类似“F1,F2,F3……Fn”的方式命名。但是不要采用“F0”,因为这个名称在某些数据库中不被允许,比如Interbase。
索引的建立
索引是一把双刃剑,索引将提高查询的效率,但是却降低了insert/delete/update 的效率。
通常情况下,对数据的编辑频度和时限要求远远低于对数据库的查询要求,因此对于记录很多且频繁查询的数据表,必须建立索引。
大多数数据库为主键字段自动创建索引,注意为外键创建索引。
不要索引大字段,这样作会让索引占用太多的存储空间。
尽量不要索引频繁编辑的小型表。
identify字段不要作为表的主键与其它表关联,这将会影响到该表的数据迁移。如果考虑支持多数据库,建议主键采用程序生成的唯一值。
如果一个大型表需要频繁的做insert/delete/update操作,同时也需要做高并发量的查询,那么建议根据数据的访问频度对表作拆分,而后建立索引。
1