【分享】按键精灵代码风格与规范大纲 _ 【集结令●英雄归来】

查看: 7275\|回复: 43	[神梦] 【分享】按键精灵代码风格与规范大纲 [复制链接]

神梦科技

神梦无痕

组别按键认证大神
UID2699998
帖子3587
精华11
鲜花2173 朵
铜币7386 个
银币1021 个
在线时间91120
注册时间2014-08-23

1^#

字体大小: t T

发表于 2022-09-25 20:52 | |只看楼主

前言

为了让不太编码习惯的开发者更好的协助配合，并形成良好的基础编码规范与风格，整理了工作中常见的不规范操作，最终形成此按键精灵编码规范与风格。

必须：用户必须采用
推荐：用户理应采用，但如有特殊情况，可以不采用
可选：用户可参考，自行决定是否采用

ＱＱ群：624655641

一、编码风格

缩进
【必须】对于每级缩进，统一要求使用 Tab 键
【必须】续行，要求使用括号等定限界符，并且需要垂直对齐
【推荐】如果包含定界符（括号、中括号、大括号）的表达式跨越多行，那么定界符的括回符，可以放置与最后一行的非空字符对齐或者与构造多行的开始第一个字对齐。
【推荐】对于会经常改动的函数参数、数组、字典定义，建议每一行一个元素，并且每行增加一个逗号
【可选】对于 if 判断，同一行一般来说尽量不要放过多的判断条件。换行时增加一个 Tab 键
每行最大长度
【必须】每行最多不超过 120 个字符，每行代码最大长度限制的根本原因是过长的行会导致阅读障碍，使得缩进失效。（注释中包含的URL除外）
空白符
【必须】在表达式的赋值符号、操作符左右至少有一个空格
【必须】禁止行尾空白。行尾空白虽然不会造成功能性异常，但是这些空白字符会被源码管理系统标记出来显示为差异，对开发人员造成困扰
操作符
【推荐】按键精灵没有三目操作符，对于二目操作符来说，操作符允许在换行符之后出现。
括号
【推荐】对于优先级高的判断条件用括号括起来，看起来更直观
空行
【必须】模块中的一级函数和类定义之间，需要空两行
【必须】类中函数定义之间，空一行
【必须】源文件须使用且仅使用一个换行符作为结尾
【必须】通常每个语句应该独占一行
【必须】可以在代码片段中空一行来区分不同业务逻辑块
模块引用（import）
【必须】必须每个导入都独占一行
【必须】导入应该放在文件顶部，位于模块注释之后，模块全局变量和常量之前
【推荐】导入应该按照从最通用到最不通用的顺序分组，每个分组之间需空一行：
　　　　官方模块导入
　　　　第三方模块导入
　　　　自写模块导入
【必须】禁止导入了模块却不使用它
注释

有效的注释有助于帮助开发者更快地理解代码，模块，函数，子程序，以及行内注释的都有各自的风格。

【必须】所有 // 开头的注释，必须与所在的代码块同级，并置放在代码之上
【必须】所有 ' 开头的注释，必须与代码同行，置放在代码尾部
【必须】注释的每一行都应该以 // 或 ' 加一个空格开头
【必须】行内注释 ' 与代码离开至少2个空格
【必须】块注释 /* */ ：对于复杂的操作，可以放在代码之前写若干行注释；对于简单的代码，可以放在行内，与代码离开至少2个空格
【必须】TODO 注释需要加上名字。TODO注释应该在所有开头处包含 TODO 字符串，紧跟着是用括号括起来的你的名字，email地址或者其他标识符，然后是一个可选的冒号，接着必须有一行注释，解释要做什么。
文档字符串（DocString）
【推荐】需对外发布的 public 模块、函数、类、子程序等需要包含文档字符串。内部使用的方法，函数等，要求使用简单的注释描述功能。一个函数或子程序，如果可以直接被其他开发者使用，需要提供文档明确其含义，需要指出输入、输出、以及异常内容
【必须】第一行应为文档名，空一行后，输入文档描述
【推荐】在使用文档字符串时，推荐使用 reStructuredText 风格类型
类型注解
【必须】按键精灵是动态语言，在运行时无需指定变量类型，虽然运行时不会执行函数与变量类型注解，但类型注解有助于阅读代码、重构。
【必须】模块级变量、类和实例变量以及局部变量可以加个后缀 [类型] 来进行注解，类型：Bool、Int、Str、Cur、Date、Array、Object、Bytes
字符串
【推荐】使用 & 进行字符串连接，避免用 + 进行字符串连接，可能会因类型不同导致出错
【推荐】避免在循环中用 & 来累加字符串，由于字符串是不可变的，这样做会创建不必要的临时对象，并且导致指数级运行时间。作为代替方案，可以将每个字串加入数组，然后循环结束后用 Join 命令连接数组中的每个字串

命名

模块名：module_name
类名：ClassName
函数名：function_name
子程序名：sub_name
常量名：CONST_VAR_NAME
全局变量名：GLOBAL_VAR_NAME
局部变量名：instance_var_name
函数参数名：function_parameter_name

【推荐】避免使用单字符名称，计数器和迭代器除外
【推荐】内部变量仅模块内部可用，或者，类内是保护或私有的，不能暴露在外部
【推荐】用双下划线 __ 开头的实例变量或方法表示类内私有
【推荐】将相关的类和顶级函数放在同一个模块里
【推荐】对类名使用大写字母开头的单词（ClassName）

二、编码规范

三目运算符
【必须】三目操作符判断，按键精灵不支持三目运算符，但是可使用如下方式，禁止使用复杂难懂的逻辑判断
条件表达式
【推荐】函数或者子程序在没有返回时要明确返回 Empty
【推荐】对于未知的条件分支或者不应该进入的分支，建议抛出异常，而不是返回一个值
【可选】 if 与 else 尽量一起出现，而不是全部都是 if 子句
True/False 布尔运算
【必须】不要用 = 与 True、False 进行布尔运算
变量
【必须】禁止定义了变量却不使用它。即使没有使用，但是定义了变量仍然需要消耗资源

三、总结

本规范适用于按键精灵所有版本产品

已有1评分我要评分查看所有评分

神梦科技最后编辑于 2022-09-25 21:19:43

游戏、办公、网页、脚本辅助定制
联系QQ: 1042207232
【命令库】利用IE+Chrome谷歌双核操纵网页填表，支持框架操作
【命令库】按键精灵也玩套接字(Sock)
SMWHff's Blog | 梦痕编程 - 神梦博客

回顶部

发送短消息 UID 2737555 帖子 176 精华 0 鲜花 38 朵铜币 438 个银币 46 个性别在线时间 3920 注册时间 2014-09-13 最后登录 2024-03-30 236024170 查看公共资料搜索主题搜索帖子 wzhuang wzhuang 组别初中一年级 UID2737555 帖子176 精华0 鲜花38 朵铜币438 个银币46 个在线时间3920 注册时间2014-09-13	2^# 字体大小: t T 发表于 2022-09-25 20:58 \| \|只看该用户谢谢分享


	回顶部

发送短消息 UID 8689099 帖子 266 精华 0 鲜花 233 朵铜币 263 个银币 263 个性别在线时间 0 注册时间 2022-04-06 最后登录 2024-04-09 727156471 查看公共资料搜索主题搜索帖子家鸿家鸿组别初中二年级 UID8689099 帖子266 精华0 鲜花233 朵铜币263 个银币263 个在线时间0 注册时间2022-04-06	3^# 字体大小: t T 发表于 2022-09-25 21:01 \| \|只看该用户


	回顶部

发送短消息 UID 8674560 帖子 11 精华 0 鲜花 0 朵铜币 6 个银币 6 个性别在线时间 0 注册时间 2022-03-26 最后登录 2022-11-03 1581689588 查看公共资料搜索主题搜索帖子 s1157047004 s1157047004 组别小学一年级 UID8674560 帖子11 精华0 鲜花0 朵铜币6 个银币6 个在线时间0 注册时间2022-03-26	4^# 字体大小: t T 发表于 2022-09-25 21:09 \| \|只看该用户 6666666666666


	回顶部

发送短消息 UID 7112160 帖子 2 精华 0 鲜花 1 朵铜币 63 个银币 2 个性别在线时间 0 注册时间 2019-11-07 最后登录 2022-10-03 查看公共资料搜索主题搜索帖子 329411221 组别幼儿园 UID7112160 帖子2 精华0 鲜花1 朵铜币63 个银币2 个在线时间0 注册时间2019-11-07	5^# 字体大小: t T 发表于 2022-09-25 21:11 \| \|只看该用户谢谢分享


	回顶部

发送短消息 UID 6514799 帖子 165 精华 0 鲜花 128 朵铜币 162 个银币 137 个性别在线时间 0 注册时间 2019-05-18 最后登录 2024-04-17 1125145293 查看公共资料搜索主题搜索帖子 13242425499 13242425499 组别初中一年级 UID6514799 帖子165 精华0 鲜花128 朵铜币162 个银币137 个在线时间0 注册时间2019-05-18	6^# 字体大小: t T 发表于 2022-09-26 06:06 \| \|只看该用户 11111111


	回顶部

发送短消息 UID 1619068 帖子 30 精华 0 鲜花 23 朵铜币 40 个银币 30 个性别在线时间 0 注册时间 2013-02-16 最后登录 2023-11-11 12345 查看公共资料搜索主题搜索帖子 hzjstt hzjstt 组别小学二年级 UID1619068 帖子30 精华0 鲜花23 朵铜币40 个银币30 个在线时间0 注册时间2013-02-16	7^# 字体大小: t T 发表于 2022-09-26 07:43 \| \|只看该用户 666感谢分享


	回顶部

发送短消息 UID 8372480 帖子 28 精华 0 鲜花 19 朵铜币 31 个银币 21 个性别在线时间 0 注册时间 2021-07-13 最后登录 2024-03-29 452025765 查看公共资料搜索主题搜索帖子 qq452025765 qq452025765 组别小学一年级 UID8372480 帖子28 精华0 鲜花19 朵铜币31 个银币21 个在线时间0 注册时间2021-07-13	8^# 字体大小: t T 发表于 2022-09-26 08:40 \| \|只看该用户分享】按键精灵代码风格与规范大纲修改


	回顶部

发送短消息 UID 3912052 帖子 140 精华 0 鲜花 36 朵铜币 250 个银币 50 个性别在线时间 1720 注册时间 2016-05-11 最后登录 2024-04-23 12345 查看公共资料搜索主题搜索帖子 xiaoqiao519 xiaoqiao519 组别小学六年级 UID3912052 帖子140 精华0 鲜花36 朵铜币250 个银币50 个在线时间1720 注册时间2016-05-11 按键精灵开发者1级可通过提升认证等级来升级勋章：rz.anjian.com	9^# 字体大小: t T 发表于 2022-09-26 10:39 \| \|只看该用户什么玩意来看看
	服

	回顶部

发送短消息 UID 4117275 帖子 65 精华 0 鲜花 43 朵铜币 83 个银币 63 个性别在线时间 20 注册时间 2016-09-13 最后登录 2024-03-25 605900736 查看公共资料搜索主题搜索帖子冯四娃冯四娃组别小学三年级 UID4117275 帖子65 精华0 鲜花43 朵铜币83 个银币63 个在线时间20 注册时间2016-09-13	10^# 字体大小: t T 发表于 2022-09-26 11:16 \| \|只看该用户感谢大佬的总结分享


	回顶部

发送短消息 UID 8308745 帖子 218 精华 0 鲜花 98 朵铜币 218 个银币 373 个性别在线时间 0 注册时间 2021-05-27 最后登录 2024-03-23 查看公共资料搜索主题搜索帖子 ouyeah999 皮蛋炒饭组别初中一年级 UID8308745 帖子218 精华0 鲜花98 朵铜币218 个银币373 个在线时间0 注册时间2021-05-27 按键精灵开发者6级可通过提升认证等级来升级勋章：rz.anjian.com	11^# 字体大小: t T 发表于 2022-09-26 12:04 \| \|只看该用户感谢大佬的总结分享


	回顶部

发送短消息 UID 3892596 帖子 2169 精华 0 鲜花 1980 朵铜币 2238 个银币 2126 个性别在线时间 92820 注册时间 2016-04-29 最后登录 2024-04-26 15177407 查看公共资料搜索主题搜索帖子 qiudi 风闲组别官方脚本作者 UID3892596 帖子2169 精华0 鲜花1980 朵铜币2238 个银币2126 个在线时间92820 注册时间2016-04-29 按键精灵开发者6级可通过提升认证等级来升级勋章：rz.anjian.com	12^# 字体大小: t T 发表于 2022-09-26 14:05 \| \|只看该用户禁止定义了变量却不使用它。即使没有使用，但是定义了变量仍然需要消耗资源
	官方脚本作者风闲联系QQ:15177407 验证码识别,数据监测,网页操作,游戏,办公,抢购,post等

	回顶部

发送短消息 UID 1104485 帖子 36 精华 0 鲜花 2 朵铜币 76 个银币 75 个性别在线时间 1080 注册时间 2012-04-23 最后登录 2024-04-19 562990812 查看公共资料搜索主题搜索帖子 nightkid821 nightkid821 组别小学二年级 UID1104485 帖子36 精华0 鲜花2 朵铜币76 个银币75 个在线时间1080 注册时间2012-04-23 按键精灵开发者6级可通过提升认证等级来升级勋章：rz.anjian.com	13^# 字体大小: t T 发表于 2022-09-26 16:52 \| \|只看该用户 666666


	回顶部

发送短消息 UID 1361792 帖子 800 精华 0 鲜花 144 朵铜币 7119 个银币 491 个性别在线时间 16760 注册时间 2012-10-12 最后登录 2024-04-25 2240669974 查看公共资料搜索主题搜索帖子 cheweidian cheweidian 组别大学一年级 UID1361792 帖子800 精华0 鲜花144 朵铜币7119 个银币491 个在线时间16760 注册时间2012-10-12 按键精灵开发者4级可通过提升认证等级来升级勋章：rz.anjian.com	14^# 字体大小: t T 发表于 2022-09-26 20:55 \| \|只看该用户支持摸摸哒


	回顶部

发送短消息 UID 3743224 帖子 105 精华 0 鲜花 6 朵铜币 624 个银币 176 个性别在线时间 5140 注册时间 2016-02-05 最后登录 2023-06-25 查看公共资料搜索主题搜索帖子 1598451931 1598451931 组别小学五年级 UID3743224 帖子105 精华0 鲜花6 朵铜币624 个银币176 个在线时间5140 注册时间2016-02-05 按键精灵开发者4级可通过提升认证等级来升级勋章：rz.anjian.com	15^# 字体大小: t T 发表于 2022-09-27 10:04 \| \|只看该用户上课学习学习


	回顶部

发送短消息 UID 8215152 帖子 107 精华 0 鲜花 111 朵铜币 123 个银币 108 个性别在线时间 0 注册时间 2021-03-20 最后登录 2024-03-07 245135241 查看公共资料搜索主题搜索帖子 245135241 245135241 组别小学五年级 UID8215152 帖子107 精华0 鲜花111 朵铜币123 个银币108 个在线时间0 注册时间2021-03-20 按键精灵开发者2级可通过提升认证等级来升级勋章：rz.anjian.com	16^# 字体大小: t T 发表于 2022-09-27 10:30 \| \|只看该用户 11111 111


	回顶部

发送短消息 UID 3187553 帖子 19 精华 0 鲜花 8 朵铜币 80 个银币 10 个性别在线时间 180 注册时间 2015-04-10 最后登录 2022-09-29 查看公共资料搜索主题搜索帖子兰海传奇兰海传奇组别小学一年级 UID3187553 帖子19 精华0 鲜花8 朵铜币80 个银币10 个在线时间180 注册时间2015-04-10	17^# 字体大小: t T 发表于 2022-09-29 09:48 \| \|只看该用户感谢分享
	兰海传奇

	回顶部

发送短消息 UID 767911 帖子 15 精华 0 鲜花 3 朵铜币 33 个银币 11 个性别在线时间 360 注册时间 2011-09-09 最后登录 2022-11-24 276501600 查看公共资料搜索主题搜索帖子 chenhaokuenb chenhaokuenb 组别小学一年级 UID767911 帖子15 精华0 鲜花3 朵铜币33 个银币11 个在线时间360 注册时间2011-09-09	18^# 字体大小: t T 发表于 2022-09-29 15:25 \| \|只看该用户学习下


	回顶部

发送短消息 UID 6748060 帖子 9 精华 0 鲜花 5 朵铜币 15 个银币 6 个性别在线时间 0 注册时间 2019-07-19 最后登录 2024-04-10 查看公共资料搜索主题搜索帖子 spp0210 spp0210 组别小学一年级 UID6748060 帖子9 精华0 鲜花5 朵铜币15 个银币6 个在线时间0 注册时间2019-07-19	19^# 字体大小: t T 发表于 2022-09-29 16:58 \| \|只看该用户 dddddd


	回顶部

发送短消息 UID 3784717 帖子 2 精华 0 鲜花 1 朵铜币 12 个银币 2 个性别在线时间 0 注册时间 2016-03-01 最后登录 2022-09-30 查看公共资料搜索主题搜索帖子 linshuan linshuan 组别幼儿园 UID3784717 帖子2 精华0 鲜花1 朵铜币12 个银币2 个在线时间0 注册时间2016-03-01	20^# 字体大小: t T 发表于 2022-09-29 22:31 \| \|只看该用户谢谢分享


	回顶部

上一主题| 下一主题

[神梦] 【分享】按键精灵代码风格与规范大纲 [复制链接]

11111