# ModuleProject_ts

**Repository Path**: myandroid008/ModuleProject_ts

## Basic Information

- **Project Name**: ModuleProject_ts
- **Description**: cocos creator ts版本的模块工程及其测试说明
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2020-05-16
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ModuleProject_ts

#### 介绍
cocos creator ts版本的模块工程及其测试说明

### 说明
将根目录下面的 Module.code-snippets文件放入 C:\Users\admin\AppData\Roaming\Code\User\snippets 文件夹下面来获得自定义用户代码片段的智能提示效果

ModuleProject为标准模块工程（不断完善优化中）
ModuleProject_test是对ModuleProject中的模块文件和模块功能的测试工程


#### 代码规范说明

1. 文件位置规范及说明
(1) 所有ts脚本都放在scripts下，scripts下面可以按需求建立子文件夹
(2) GGame 里面用来放游戏业务逻辑 相关 的全局模块脚本
(3) GModule 里面用来放跟游戏业务逻辑 无关 的全局模块脚本（模块工程的标准文件）
(4) 上面2,3里面的全局模块都以 "G" 开头，表示 Global 的意思，"G"后面的字母大写，如"GData"
(5) Scenes里面放场景相关的主要脚本，脚本名字跟场景名字一样，大写开头

2. 业务组件脚本规范
(1) 组件脚本都以大写开头
(2) 一般情况，场景和预制 的根节点 上面都挂有一个跟其同名的组件脚本
(3) 组件里面的每个函数（除了onLoad，onDestroy这样的原生函数）都需要写上 
    1.函数作用说明，注释可以用文档注释 /** */ 或者普通注释 // （建议用文档注释） 
    2.参数类型可写，3.参数说明可写 4.使用示例可写   2，3，4清楚的尽量写

3. 其他规范
(1) 文件里面的变量采用“驼峰命名”法，小写开头, 如 let bigNumber = 0;
(2) 全局模块文件需要写好：1.函数作用说明 2.参数类型 3.参数说明，参数是否可选等 4.使用示例  注释全部用文档注释 /** */，这样的注释会有智能提示，方便函数调用
    全局模块的写法可以参考 "global" 智能提示
(3) 全局模块里面对外暴露的接口函数和内部调用的私有函数，私有变量要分开。
    其中私有函数，私有变量以下划线"_"开头，用private标记，此时不对外暴露智能提示

4. 函数写法规范及其等级上升规范
1.函数功能尽量简单，尽量减少依赖
2.组件脚本里面 只在一个函数域使用 的代码块不需要独立成函数，
  在同一个组件脚本 多个函数域使用 的代码独立成函数，函数写在该组件脚本里面
  在 不同组件脚本都调用的业务逻辑 相关的代码升级为 全局模块函数，函数写在 GGame 里面的模块里面
  在 不同组件脚本都调用的非业务逻辑 （如：随机一个范围的整数） 相关的代码升级为 全局模块函数，函数写在 GModule 里面的模块里面