Android 项目开发规范
代码命名规范 基本命名规范 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式 杜绝完全不规范的缩写，避免望文不知义 包名 包名为小写 点分隔符之间有且仅有一个自然语义的英语单词，包名中单词统一使用单数形式 类名 类名必须是一个名词，每个单词首字母大写。除了约定俗成的缩写，尽量使用完整单词 实现类如果和接口区分，请在接口名后加 Impl 抽象类命名使用 Abstract 或 Base 开头 异常类命名使用 Exception 结尾 测试类命名以它要测试的类的名称开始，以 Test 结尾 如果使用到了设计模式，建议在类名中体现出具体模式，有利于阅读者快速理解架构设计思想 枚举类名建议带上 Enum 后缀 方法名 动词或动词 + 名词 采用驼峰命名方式，第一个单词首字母小写，其它单词首字母大写 变量名 采用驼峰命名方式，首字母小写，其后单词的首字母大写 内部使用的变量加m前缀 静态变量加s前缀 控件名不需要和 id 名一致，采取统一的缩写前缀 常量名 使用 st...
前端开发规范
HTML 规范 HTML 类型 推荐使用 HTML5 的文档类型申明： （建议使用 text/html 格式的 HTML。避免使用 XHTML。XHTML 以及它的属性，比如 application/xhtml+xml 在浏览器中的应用支持与优化空间都十分有限）。 规定字符编码； IE 兼容模式； 规定字符编码； doctype 大写； 正例： 1234567891011<!DOCTYPE html><html> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta charset="UTF-8" /> <title>Page title</title> </head> <body> <img src="images/company-logo.png" al...
Java 项目开发规范
Java 项目规范 Java 项目命名规范 全部采用小写方式， 以中划线分隔。 123正例：`mall-management-system / order-service-client / user-api`反例：`mall_management-system / mallManagementSystem / orderServiceClient` 方法参数规范 无论是 controller，service，manager，dao 亦或是其他 class 的代码，每个方法最多 5 个参数，如果超出 5 个参数的话，要封装成 javabean 对象。 方便他人调用，降低出错几率。尤其是当参数是同一种类型，仅仅依靠顺序区分，稍有不慎便是灾难性后果，而且排查起来也极其恶心。 保持代码整洁、清晰度。当一个个方法里充斥着一堆堆参数的时候，再坚强的人，也会身心疲惫。 反例： 123456789101112131415/*** 使用证书加密数据工具方法** @param param 参数* @param password 加密密码* @param priCert 私钥* @para...
Web 开发规范
什么是好的代码？ 满足业务需要：代码是来实现业务的，如果业务都实现不了，代码也就没什么价值了 代码尽可能的清晰明了：就是让小白也能看懂你的代码 代码尽可能的少：在保证清晰明了的前提下，能少一行少一行，能少一个类少一个类，能少一行注释少一行注释 代码尽可能复用性和模块化：在保证清晰明了和尽可能少的前提下，能复用的代码尽量复用，能模块的尽量模块 英文单词命名规范 无论前端代码还是后端代码，都是由一个个单词组成的，所以好的命名规范至关重要： 1）合理使用正确的英文单词 一定要用英文，且单词正确，不要用汉语拼音； 英文单词一定要使用常用词； 英文单词要符合业务； 2）合理区分名词和动词 项目名、类名、数据库名、表名应该用名词，比如： OrderService。 具体的方法名应该是 动词 或 动名词，比如：创建订单 createOrder，查询订单 queryOrder。 3）各个端、数据库、等命名要统一 前端、后端、移动端、数据库、服务器对某个业务或者某个业务单元的命名必须保持一致。 12345比如 `通知` 功能，各个端定义为： - 后端: `not...