文档介绍：AnyFo 代码编写规范
主编:安坤
版本号:
目录
目录 2
1 Java包规范 3
包结构规范 3
包命名规范 3
2 类规范 3
类命名规范 3
接口命名规范 4
接口实现类名规范 4
抽象类类名规范 4
a) 抽象类的子类类名规范 4
函数命名规范 4
变量命名规范 4
常量名规范 4
Eclipse编码规范模板 5
3 注释规范 5
类注释规范 5
接口注释规范 5
函数注释规范 5
代码注释规范 5
Java包规范
包结构规范
包名最前面一定是企业或组织的官方站点网址,如:.anyfo,称之为“根包”
每个产品或项目都有自己的名字,在根包名后面应该加上自己的名字,而项目的所有东西都放在以自己名字命名的包下,如:通用权限系统“Forget”,.
几乎每个项目都分为前台和后台两部分代码,,如:

不管前台还是后台,代码都分模块存放,模块下面又分子模块,则跟着的包名又按照各模块的结构建立,如:

如果后台用的是EJB3,则每个功能点分为两个部分
Persistence里的实体- 包名定为entities
前台能直接调用的会话Bean - 包名定为logic
则包结构为:
(这个模块的会话Bean的类和接口都放在这里)
(这个模块的所有实体都放在这里)
包命名规范
包名中绝对不允许出现大写字母。
如果需要将包名中的各单词分开,单词间用“_”连接。如:user_system
包名单词要能顾名思义。
类规范
类命名规范
类名中,每个单词开头字母要大写,其他字母要小写,如:FileManager
类名单词要能顾名思义
接口命名规范
接口名要以“I”开头,如:IDriver
接口中每个单词开头字母要大写,其他字母要小写,如:IDriver
接口实现类名规范
接口实现类的名字要以Impl结尾,如:CameraDri