Q_RFZN 001-2019通用编程规范.pdf

  Q/RFZN 001-2019 Q/RFZN 日照市人防智能科技有限公司企业标准 Q/RFZN 001-2019 通用编程规范 2019-08-09 发布 2019-08-09 实施 日照市人防智能科技有限公司     发 布 Q/RFZN 001-2019 前   言 本标准按 GB/T 1.1—2009 《标准化工作导则第 1 部分：标准的结构和编写》的规定编写。 本标准由日照市人防智能科技有限公司提出。 本标准起草单位：日照市人防智能科技有限公司。 本标准主要起草人：李迪。 本标准于2019年08月09日首次发布。 I Q/RFZN 001-2019 通用编程规范 1　范围 本标准规定了日照市人防智能科技有限公司软件研发编码规范。 本标准适用于日照市人防智能科技有限公司承担的各类软件研发类项目。 2　术语和定义 下列术语和定义适用于本标准。 2.1　 类 类（Class）是面向对象程序设计（OOP，Object-Oriented Programming）实现信息封装的基础。 类是一种用户定义类型，也称类类型。每个类包含数据说明和一组操作数据或传递消息的函数。类的 实例称为对象。 2.2　 变量 变量来源于数学，是计算机语言中能储存计算结果或能表示值抽象概念。变量可以通过变量名访 问。在指令式语言中，变量通常是可变的；但在纯函数式语言（如Haskell）中，变量可能是不可变 的。在一些语言中，变量可能被明确为是能表示可变状态、具有存储空间的抽象（如在Java 和 Visual Basic 中）；但另外一些语言可能使用其它概念（如C 的对象）来指称这种抽象，而不严格地定 义 “变量”的准确外延。 2.3　 注释 注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时， 写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。 2.4　 函数 函数是指一段在一起的、可以做某一件事儿的程序。也叫做子程序、（OOP 中）方法。函数分为全 局函数、全局静态函数；在类中还可以定义构造函数、析构函数、拷贝构造函数、成员函数、友元函 数、运算符重载函数、内联函数等。 3　产品分类 公司技术文档规范 4　技术要求 4.1　总则 使用一致的编码方法和编程方法来提高代码质量，提升软件的品质和性能。 1 Q/RFZN 001-2019 使用一致的正确语义的编码标准、编码方法并在日后工作中保持例行代码检查，使软件项目更方 便理解和维护。 4.2　命名规则 4.2.1　命名原则 命名长短适中且表达实际意义，便于理解。 使用容易理解的描述方式，避免歧意。 尽量减少使用缩写。 4.2.2　类的相关命名 在类的属性命名中包含类是多余的，例如Book.BookTItle应该改为Book.Title。 类名及属性使用名词。 方法使用动词或者动词加名词方法来命名。 方法名称类名称第一个字母要大写。 命名方法时包括返回值的说明，比如使用GetXXXVal