代码规范
编码规范：
- 缩进：必须使用 4 个空格缩进。（而不是table）
- 单行：单行字符数限制不超过 120 个，超出需要换行。
- 变量：必须书写变量修饰符，私有变量要加前缀下划线“_”。
- 空格：在操作符前后一般要添加空格，如、+、-、、*、%。例
let count = 100; - 引号：字符串一般使用单引号，模版字符串使用反引号，来自 html 变量的引用使用双引号。
- 逗号：逗号用于变量声明的分隔或元素的分隔，如逗号不再行结尾，需添加空格，此为，逗号不允许出现在行首。
- 分号：表达式结尾添加分号。
- 编码：统一使用 UTF-8。
- 大括号：开头大括号无需另起一行，结尾换行。
- 单个类代码量：业务逻辑类一般不得超过 1000 行左右，算法类在 3000 行左右，工具类一般在 800~1000 行左右。
- 单个方法代码量：方法不应该超过 200 行，超过尽量做拆分。50行左右最佳。
命名规范：
- 命名：严禁使用拼音与英文混合的方式，杜绝完全不规范的缩写，避免望文不知义。如使用到了设计模式，尽量在命名中体现出具体模式。
- 变量命名：必须小驼峰式命名，尽量要以名词命名(领域模型的相关命名除外) DO/BO/DTO/VO 等。
- 方法命名：必须小驼峰式命名，与变量不同是方法名必须动词或判定性词汇。
- 类命名：必须大驼峰式命名，例：
Student。 - 常量命名：必须所有字母使用大写，用下划线分割单词，力求语义表达完整清楚。不允许任何未经定义的常量直接出现在代码中。
- 文件命名：必须和类名相同。
- 包名：一般使用适当短且有意义，必须由一组小写字母组成。
- 接口：接口中的方法和属性不要加任何修饰符号，public 也不要加，保持代码的简洁性，并加上有效的注释。
- 枚举：枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
数据表
- 数据表和字段采用小写加下划线方式命名，并注意字段名不要以下划线开头，例如 think_user 表和 user_name 字段。
注释规范：
编程范式：
- 根据需求选择 oop、fp 等、个人喜欢 fp。
- 任何变量或方法必须先声明在使用，无论编程语言是否有硬性要求。
版本控制：
- 版本控制选择 Git 或 SVN，强烈建议使用 git 管理代码。
说明：
- 带有关键词“必须”为强制遵守，带有“一般”为可
- 此规范为通用规范，如与项目语言有冲突，一项目开发规范为准，则必须遵循此规范
常用设计模式命名：
- Singleton(单例)，Proxy(代理)，Command(命令)，Mediator(中介)，Observer(观察者)
游戏开发常用文件命名：
- 页面：页面文件命名“功能说明”+“Page”,二级页面文件命名“功能说明”+“Page2”，以此类推。
- 皮肤：皮肤文件命名“功能说明”+“Skin”。
- 地图：地图文件命名“功能说明”+“Map”。
- 按钮：按钮中变量或属性“btn”+“功能说明”。
- 文字：文字中变量或属性“txt”+“功能说明”。
- 位图：位图中变量或属性“bmp”+“功能说明”。
游戏开发常用命名单词：
- data(数据)、tools(工具)、view(界面)、user(用户)、info(信息)、config(配置)、module(模块)
- content(内容)、tip(提示)、item(项目)、explain(说明)、container(容器)、msg(消息)、attr(属性)
- callback(回调)、checkpoint(关卡、检查点)、handle(处理)、thisObj(多指this指向)、count(计数)
- gift(礼物)、knapsack(背包)、bags(可做背包使用、袋子)、equipment(装备)、main(主要)、type(类型)
- create(创建)、release(释放)、update(更新)、upgrade(升级)、req(请求)
- next(下一步)、back(上一步)、refresh(刷新)、complete(完成)、by(通过、由)
- buy(购买)、fresh(新鲜的)、spend(花费)、sync(同步)、async(异步)、is(一般以检查开头)、cmd(命令)
网友评论