DB31/T 787-2014
能源计量数据采集系统 通用代码规范
发布时间:2014-04-24 实施时间:2014-07-01


能源计量数据采集系统是指用于采集、处理、存储和分析能源计量数据的软件系统。能源计量数据采集系统的开发和应用对于能源管理和节能减排具有重要意义。为了提高能源计量数据采集系统的代码质量和可维护性,促进能源计量数据采集系统的开发和应用,本标准制定了能源计量数据采集系统通用代码规范。

1. 代码命名
1.1 代码命名应简洁明了,符合语言习惯,避免使用拼音、缩写等不易理解的命名方式。
1.2 代码命名应具有描述性,能够准确反映代码的功能和作用。
1.3 代码命名应遵循驼峰命名法,即首字母小写,后面每个单词的首字母大写,如energyMeter。

2. 代码编写
2.1 代码应具有可读性和可维护性,应遵循模块化、结构化编程思想,避免使用过于复杂的算法和逻辑。
2.2 代码应具有可重用性,应尽量避免重复编写相同或类似的代码。
2.3 代码应具有可扩展性,应考虑未来可能的需求变化,预留扩展接口和扩展点。

3. 代码注释
3.1 代码应添加必要的注释,注释应简洁明了,能够准确反映代码的功能和作用。
3.2 注释应遵循中文注释,避免使用英文注释或拼音注释。
3.3 注释应放在代码块的上方,用于解释代码块的作用和功能。

4. 代码格式
4.1 代码应遵循统一的格式,包括缩进、空格、换行等方面的要求。
4.2 代码应遵循统一的代码风格,包括代码布局、命名方式、注释方式等方面的要求。
4.3 代码应遵循统一的代码规范,包括代码编写、代码测试、代码提交等方面的要求。

相关标准:
GB/T 18487.3-2017 能源管理信息系统数据采集与处理 第3部分:数据采集
GB/T 18487.4-2017 能源管理信息系统数据采集与处理 第4部分:数据处理
GB/T 18487.5-2017 能源管理信息系统数据采集与处理 第5部分:数据存储
GB/T 18487.6-2017 能源管理信息系统数据采集与处理 第6部分:数据分析
GB/T 18487.7-2017 能源管理信息系统数据采集与处理 第7部分:数据交换