Unity 代码规范(PlateFace)1.0版本

PlateFace Unity开发规范(1.0)

1.项目都采用英文名命名,图片,音频,资源都不能采用中文.

2.方法名: 帕斯卡命名(所有单词首字母大写)

3.字段: 在Unity中组件字段名第一个字母小写,其他字母大写(骆驼命名法)

4.注释: 所有公开的字段, 属性,方法, 采用文档注释,    只有私有字段,方法,可以选择注释

/// <summary>

/// 文档注释

/// </summary>

//普通注释

5.所有类都已LY命名空间向后扩展(建议修改Unity C#模板方便以后开发)

实体类:     namespace  LY.Entity             LYScript/Enitiy

功能类:     namespace  LY.Script             LYScript/Script

公共组件:   namespace  LY.Common          LYScript/Common

等等.....

Namespace LY.Scirpt{
public class ChangRoleHead : MonoBehaviour {
       代码
    }
}

6. 如果一个类的方法,字段过多应考虑使用#region折叠来

7.后缀名:

接口:  xxxxIe

委托:  xxxxDe

事件:  xxxxEvent

枚举:  xxxxEnuem

游戏物体:

1. 游戏中每类个UI游戏物体以Panel为后缀名. 比如游戏开始菜单

2. 如果一个Panel中存在太多的游戏物体可考虑

TopLeft           Top         TopRight

MiddleLeft       Middle     MiddleRight

BottomLeft      Bottom    BottomRight

资源:

1. 图片,音频等等请不要直接是1000.jpg, 这种编号命名. 请使用英文bullet.jpg. 如果图片一系列 bullet1000  bullet1001 这种方式

2. 如果资源发包时候可以删除后缀名加D  例子:  bulletD.jpg,  xxxD.音频

3. 如果你发现图片资源不规则,不知道放入哪一类图片文件夹中, 请在 Resource/Image/xxxPanel(需要这样请联系你的老大商量)

文件夹:

脚本:  

MyScript/Common 公共脚本

MyScript/Entity 实体类

MyScript/Script 普通组件

MyScript/Interface 接口

MyScirpt/Enum 枚举

MyScript/Script/独立的框架脚本

MyScript/Scirpt/UI

MyPlugins/xxxx/使用的插件请转移到这里

资源:

Resource/Atlas纹理

Resurce/Image/UI      UI

Resurce/Image/Texture  贴图

Resurce/Font          字体

Resurce/Prefabes       预设

Resurce/Sound/Music   游戏音乐

Resurce/Sound/FX      游戏音效

====================================================================================================================================================

实际编码部分:

1. 所有的组件必须按照  组件- > MyCompoment -> MonoBehaviour 继承

2. 游戏音效都由 SoundController 统一播放, 如果不统一 需要监听SoundController.isOpen 属性,来确定是否播放

3. 所有正式调试功能都要注册到 调试中心

=======================================================================================================================================================

团队合作部分:

1. 请不要随便联系你的老大问问题, 如果发现你的问题解决不了, 或者需要很长的时间来解决,项目时间又很紧急. 你可以联系你的老大. 你要记住问的越多学的越少, 自己学来的和别人跟你讲的是完全不一样的.

2. 请给你的老大提供你编程详细的技术领域比如, 在项目中难免会遇到其他的技术领域,你需要提供详细的资料给你老大. 好合理的安排任务

3. 当你任务完成的时候, 建议你询问下你的团队是否需要帮助,或者遇到什么问题? 我这边能帮你解决吗? (当你觉得的程序不是一个人编写的时候,你已经在另一个领域了)

4. 生活需求: 如果你觉得工资太少, 请在不忙的时候给你老大申请需要调整到多少月薪。(老大会认真审核的);

5.如果你对团队某人存在意见,请私下和老大说明. 老大会安排你们两个公聊(老大在旁边听,你们就谈事,希望不要打起来), 如果发现你觉得工资,这里学习不到技术,你对某人有意见。 藏着心里不说. 严重影响到工作部分的时候直接开除.

6. 你有什么框架或者改善团队的方法. 可以给老大说明. 以团队投票决定是否开展

7. 欢迎你加入团队,可以的话能在工作以外成为好朋友. (你要搞基也无所谓)这里极力创建一个团队, 且不是创建在一群人在一起写代码环境.

 

注意事项:

1. 项目中尽量不使用3个字母简写方式

2. 如果你发现开发规范与实际开发有什么不合, 请联系你的老大回报情况