Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.12 KB

README.md

File metadata and controls

46 lines (34 loc) · 2.12 KB

MycroftToolKit

1. 工具索引👍

名称 功能 日期 维护人
QuickCode 通用快速编码包 22-02-08 Mycroft
Timer Unity计时器 22-02-08 Mycroft
DiscreteGridTools 关于离散网格地图的一些常用算法工具(四边形,六边形) 22-02-08 Mycroft
JumpWord 跳字效果组件 22-02-08 Mycroft
EntityMovementPathEditor 可视化移动路径组件 22-02-08 Mycroft

2. 使用说明👍

本代码库用于技术积累和提升大家的编码效率。 大家也可以总结一些高频率使用的代码封装成工具包放到这里。

3. 提交说明👍

3.1 编码规范

工具包的编码需要遵循以下几个原则:

  1. 绝对正确原则 工具包上传前要自己做好测试,保证没有Bug
  2. 最小依赖原则 工具包尽量不要依赖其他工具包或其他额外的扩展,插件
  3. 最小暴漏原则 工具包的细节不要暴漏在外,内部的代码的权限要严格设计,仅把对外API设为共有
  4. 报错清晰原则 工具包代码的鲁棒性要强,需要考虑使用者各种非法输入的报错,能快速定位问题
  5. 注释覆盖原则 工具包对外API应使用///注释,内部使用//注释,关键的地方一定写好注释
  6. 代码署名原则 多人合作的工具包需要每人对自己写的代码用//注释署名,出现问题好迅速联系解决

3.2 文档规范

文档模板详见 工具包README模板.md

3.3 提交规范

  1. 工具包上传时必须附带readme文档文件
  2. 工具包修改后需要及时更新readme文档
  3. 提交代码必须填写提交注释 注释格式:工具包目录/修改的子目录: 修改内容