1 源代码抬头做文件的介绍,
2 文件名首字母大写
3 package所有字母小写
4 每个类抬头写类注释
5 常见的命名规范
- pascal命名法 int MyAge 类名,文件名
- camel命名法 int myAge (java常用) 首字母小写,方法,变量
- 匈牙利命名法 int strMyAge 前缀标定类型或者特征 静态、私有成员变量
- 下划线命名法 int m_Name 常量
6 项目文档文件夹:
1 Requirement 需求相关文档
2 design 设计文档
3 planning&log 计划,日志
4 Test 测试报告
5 study 学习资料,demo等
6 Publish 发布部署
7 src 源代码及单元测试
7 命名规则
包的命名:全部小写
文件名 :PASCAL命名法
类名:同文件名
方法名:动宾短语,构造函数同类名,其他函数用camel命名法
接口名:同类名,加interface后缀
变量名:
- 私有成员变量: m+Pascal命名 mMyName;;
- 静态成员变量:s+Pascal命名 sMyName;
- 局部变量: Camel 命名
- 循环变量: 无意义字母
8 一些注意事项
避免将多个类放一个文件里面,除非是内部类
一个函数的长度不要超过35行
用定义的常量替代字符串
IO操作也考虑异常
尽量使用接口