代码规范

代码规范

编码规范:

  • 缩进:必须使用 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(命令)
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,686评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,668评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,160评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,736评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,847评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,043评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,129评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,872评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,318评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,645评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,777评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,861评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,589评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,687评论 2 351

推荐阅读更多精彩内容

  • 最近写python对于一些代码规范问题感觉有些地方自己还需要加强,翻阅很多文章,特此奉上官方中文翻译版以便日后查看...
    PeterPZ阅读 3,479评论 0 15
  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 4,446评论 21 35
  • 推荐文章:禅与 Objective-C 编程艺 前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、...
    WolfTin阅读 2,755评论 0 1
  • 2018-10-15日usdt被恶意做空,BTC从6200最高涨到了8100。 这时候我高点卖出了btc, 其实同...
    币圈牛市要来阅读 123评论 0 0
  • 淳熙丙申至日,予过维扬。夜雪初霁,荠麦弥望。入其城,则四顾萧条,寒水自碧,暮色渐起,戍角悲吟。予怀怆然,感慨今昔,...
    尘里微光阅读 819评论 0 3