基于Unity开发工程规范(一)

 

1 View层数据项命名约束

• View层数据都要求基层于基类

  基类：UIDataBase

• UI界面初始化数据：

  说明：用于界面数据的初始化操作(进入数据)

  开头：UIDataIn

• UI界面输出数据

  说明：用于保存由UI界面获取到的数据（输出数据）

  开头：UIDataOut

2 View层数据项及类的定义

• UI界面数据项放在在对应界面的类的前面

  列如：保存设设计界面的数据项及控制脚本

'

/// <summary>
/// 初始化UI界面的数据
/// </summary>
public class UIDataInSaveDesin : UIDateBase
{
    //TODO: 添加显示界面需要的数据项
}

/// <summary>
/// 导出的UI界面数据
/// </summary>
public class UIDataOutSaveDesign : UIDateBase
{
    //TODO: 添加界面输出的数据项
}

/// <summary>
/// UI界面类
/// </summary>
public class UISaveDesign : UIComponentBase
{
    //TODO: 添加显示界面元素及对应的控制显示方法
}

'

• 类内部组织结构

  注意内部变量的存放先后顺序

‘
/// <summary>
/// UI界面类
/// </summary>
public class UISaveDesign : UIComponentBase
{
    /* 界面元素*/
    /* 界面数据*/
    /* 外部事件*/
    /* 公共方法*/
    /* 内部逻辑处理 */
}

  定义变量及方法等要注意封装，Public修饰的放在前面，private在后面

3 各类之间的命名规则

• 各类之间的命名尽可能要求统一性

  比如上面的例子，除前缀不同外

  • UI
  • UIDataIn
  • UIDataOut

  后面的名称都是相同的意义，均指向同一界面

4 事件命名

• 开头1：On
• 开头2：如果是Unity常见事件如 Click Down Up Drag等
• 命名：根据事件意义命名
• 结尾：Event
• 例子：

  public event Action<UIDataSaveMyDesign> OnClickSaveButtonEvent;