对一套源代码的规范和风格的讨论及优化改进
工程实践项目还在前期调研阶段,目前还没正式开展代码阶段,由于做的是 JAVA 相关的,我总结了一些关于 JAVA 代码规范的经验。 一般原则 l 尽量使用完整的英文描述符 l 采用适用于相关领域的术语 l 采用大小写混合增强可读性 l 尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一 l 避免使用长的名字 l 避免使用类似的名字,或者仅仅是大小写不同的名字 l 避免使用下划线(除静态常量等) 命名的字母大小写问题 l 包名: 字母全小写 例如 : cn.coderstory.Activity.Main l 类,接口 :首字母大写,其他全小写 例如 : class Container l 方法,变量 :第二个单词开始首字母大写 例如 : seedMessage l 常量: 大写,单词用 “_” 分割 例如 : final static MIN_WIDTH = 4 l 接口 :首字母大写 ,后缀 Impl 例如 : class ContainerImpl l 异常类: 首字母大写, 后缀 Exception 例如 : DataNotFoundException l 抽象类 :首字母大写, 前缀 Abstract 例如 : AbstractBeanDefinition l Test 类: 首字母大写, 后缀 Test 例如 : public Location