Camstar开发C#代码规范、Camstar更新以及Designer 开发规范

C#代码规范

1.通用的两种代码规范:Camel(驼峰式)、Pascal(帕斯卡)

驼峰式第一个单词小写,后面单词首字母大写其余小写(例如:containerName

帕斯卡所有单词首字母大写其余都小写(例如:Lotstart

2.当且仅当私有成员可以使用下划线开始例如:private string  _containerName)

3.参数名、成员变量、局部变量都统一使用驼峰式例如:public void addSolitstring container Name)、string  arrayDemo

4.类中的声明、方法和属性加上有效的Summery注释

例如:

 

5.所有类名称以及命名空间都使用帕斯卡规范(例如:namespace Camstar.Camstar Portal.App_Code.WebPortlets.Shopfloorcalss ResultCode)

6.本地变量以及参数名使用驼峰式规范

7.捕获异常必须做异常处理

8.如果if语句块的内容只有一行,可以不加花括号,并且最好和if语句位于同一行

例如:ifindex>0return 1;

9.类型成员的排列顺序自上而下依次为:

字段:私有字段、受保护字段

属性:私有属性、受保护属性、公有属性

事件:私有事件、受保护事件、公有事件

构造函数:参数数量最多的构造函数,参数数量中等的构造函数,参数数量最少的构造函数

方法:重载方法的排列顺序与构造函数相同,从参数数量最多往下至参数最少

10.如果方法返回的类型是bool类型,则其前缀为Is,例如:IsHidden

11.如果某个属性的类型为bool类型,则其前缀为Can,例如:CanHidden

12.集合类型命名:

数组:int[] startArray;  列表:List<Student> studentList;  表:DataTable/HashTable  

DataTable  startTable;

Camstar更新

1.MDB差异文件导出

1)开发之前文件称之为BaseMDB,开发之后文件为Modified MDB

2MDB文件路径:C:Program Files (x86)CamstarInSite Administration

3)打开Camstar Metadata Export选择相应的BaseMDBModified MDB

 

4)可以选择Select All,选择所有差异。

 

5)完成后可生成xml文件和html文件。

Designer 开发规范

(1)CDOS

新建对象及Filed不允许出现拼音,如果对象长度过长,可以使用英文缩写。

新建历史记录CDO,必须处于ServiceHistorySummaryServiceHistoryDetail

 

新建Services CDO,需要建立在对应节点的套件节点之下。例如:

 

(2)CLFs

创建CLF必须建立UserFunctions节点下

(3)Fields

Field Name必须以固定前缀开头,不允许出现拼音,过长允许使用简写

(4)Functions

创建客制化function必须建立在UserFunctions节点下且必须以下划线开头。

(5)Querys

创建客制化Query必须建立在AdvancedQuery节点下

6Labels

创建客制化Label必须建立在OtherCompletion(成功)和OtherReject(失败)节点下

 

站在巨人的肩膀上真的会看的更远更清晰!

                           -----用志不分,乃凝于神

原文地址:https://www.cnblogs.com/xiong950413/p/9549853.html