上海某公司绩效管理系统编程规范 本文档总结了上海某公司绩效管理系统编程规范的知识点,涵盖了命名规范、编程规范、注释规范等方面的内容。 一、命名规范 1. 命名规则:Pascal Casing、Camel Casing、Upper Casing 2. 类的命名:用Pascal Casing命名规则,谨慎使用缩写,不要使用任何的前缀和下划线命名。 3. 方法的命名:用Pascal Casing命名规则,谨慎使用缩写,用动词或动词短语来命名。 4. 属性的命名:用Pascal Casing命名规则,谨慎使用缩写,用名词或名词短语来命名。 5. 接口的命名:用Pascal Casing命名规则,谨慎使用缩写,统一用I作为前缀,避免使用下划线命名。 6. 参数的命名:用Camel Casing命名规则,谨慎使用缩写,由本地的参数类型+描述性单词。 7. 变量的命名:用Camel Casing命名规则,避免无意义的变量命名。 8. 类库的命名:以系统的功能模块来划分类库,所有的类库的命名空间用KPI.开头。 9. 文件的命名:用Pascal Casing命名规则,公共引用层文件命名参考类的命名,实体层文件命名分为数据库实体、自定义实体、条件实体。 二、编程规范 1. 代码组织结构:按照功能模块划分类库,公共引用层、实体层、逻辑层和数据层。 2. 类库的组织结构:公共引用层命名Common,实体层命名KPI.Model,逻辑层命名KPI.Strategy,数据层命名KPI.Data。 3. 文件的组织结构:公共引用层文件命名参考类的命名,实体层文件命名分为数据库实体、自定义实体、条件实体。 三、注释规范 1. 注释原则:平均每100行代码中要有20~30行注释,视程序复杂程度而定。 2. 注释内容:使用中文,例如://添加一个用户函数。 3. 类和接口的注释:在<summary>中填写类的简要描述,<remarks>中填写类的一些注意事项,Histroy填写修改记录。 4. 注释格式:/// <summary> ... </summary> 本文档总结了上海某公司绩效管理系统编程规范的知识点,涵盖了命名规范、编程规范、注释规范等方面的内容,为开发者提供了一个详细的编程规范指南。
本内容试读结束,登录后可阅读更多
下载后可阅读完整内容,剩余8页未读,立即下载
评论星级较低,若资源使用遇到问题可联系上传者,3个工作日内问题未解决可申请退款~