命名规范

栏目:eas cloud知识作者:金蝶来源:金蝶云社区发布:2024-09-22浏览:1

命名规范

目的

形成一致的EAS代码风格

使代码结构清晰,注释规范,格式统一,易于阅读

保证代码的可维护性

降低编码出错概率,提升开发效率

大小写

Pascal样式

将标识符的首字母和后面连接的每个单词的首字母都大写。

举例:

        AccountBalance 科目余额(业务接口类名)

Camel样式(默认)

标识符的首字母小写,而每个后面连接的单词的首字母都大写。

举例:

                countTable 科目表(变量名)

        大写样式

标识符中的所有字母都大写。主要针对常量的定义。

举例:

    public static final int MAX_VALUE = 100;

小写样式

标识符中的所有字母都小写。这个主要是针对包的命名。

举例:

        com.kingdee.eas.basedata

缩写

        不要将缩写用作标识符名称的组成部分

举例:

    使用 getWindow,而不要使用 getWin

不要使用EAS未被普遍接受的缩写

举例:

    AuditExcep (错误)  AuditException(正确)

在适当的时候,使用众所周知的缩写替换冗长的词组名称

举例:

    VoucherEditUI

包命名

            格式:公司性质.公司名称.产品名称.子系统.模块.功能细分;全部小写。

        公司性质:如com,org

        公司名称:如kingdee

        产品名称:如eas

        子系统:如basedata,cp

        模块:如master,bc

        功能细分:可以按需继续增加子功能

如:

com.kingdee.eas.basedata.master.account.client

com.kingdee.eas.fi.gl

WEB端自定义controller,包名需符合com.kingdee.eas.*.web.*.*Controller

类命名

类的命名采用Pascal大小写,英文单词也可为缩略词(全部大写)

举例:

    VoucherEditUI 凭证编辑界面类

    DBUtils 数据访问实用工具类

    ActionAddNew 新增动作类

自定义服务端方法:XXXControllerBean

扩展服务端方法:XXXControllerBeanEX

   

自定义WEB端Controller:XXXController

自定义WEB端事件:XXXEvent

自定义WEB端实现:XXXHandler

方法命名

        用动词或动词短语命名方法

使用Camel大小写

举例:

    removeAll()

    loadFields()

    runSubmit()

参数命名

        用描述性参数名称

对参数名称使用 Camel 大小写

不要给参数名称加匈牙利命名法的类型前缀

举例:

    string format(string format, object[] args)

    boolean exist(Context ctx, IObjectPK companyPK)

局部变量命名

        局部变量命名采用Camel大小写

采用有明确语义的单词或组合来命名

禁止用毫无意义的名字命名变量

举例:

    int a1, a2, a3; (错误)

    string abc; (错误)

    int count, sum, avg (正确)

    string number (正确)

数组变量命名

        数组应该用下面正确的方式来命名

举例:

    byte buffer[] (错误)

byte[] buffer (正确)

10 布尔变量命名

        使用is前缀

举例:

    boolean isModified;

11 常量命名

        使用大写样式

标识符中的所有字母都大写。

对于值不发生改变的常量使用final 限定符

举例:

    public static final int MAX_VALUE = 100;

    public static final String ACCOUNT = "account";

12 控件命名

        控件前缀+名称

举例:

    KDBizMultiLangBox mltName;

    KDLabelContainer lblName;


命名规范

1 目的形成一致的EAS代码风格使代码结构清晰,注释规范,格式统一,易于阅读保证代码的可维护性降低编码出错概率,提升开发效率2 大小写Pas...
点击下载文档
确认删除?
回到顶部
客服QQ
  • 客服QQ点击这里给我发消息