📜  编码标准和指南

📅  最后修改于: 2021-10-19 06:14:10             🧑  作者: Mango

设计文档中指定的不同模块在编码阶段根据模块规范进行编码。编码阶段的主要目标是通过高级语言从设计阶段后准备的设计文档中编码,然后对该代码进行单元测试。

优秀的软件开发组织希望他们的程序员保持一些定义明确的标准编码风格,称为编码标准。他们通常根据最适合他们的组织并基于他们开发的软件类型来制定自己的编码标准和指南。程序员维护编码标准非常重要,否则代码将在代码审查期间被拒绝。

制定编码标准的目的:

  • 编码标准使不同工程师编写的代码具有统一的外观。
  • 它提高了代码的可读性和可维护性,并降低了复杂性。
  • 它有助于代码重用并有助于轻松检测错误。
  • 它促进了良好的编程实践并提高了程序员的效率。

下面给出了一些编码标准:

  1. 全局变量的有限使用:
    这些规则说明哪些类型的数据可以声明为全局的,哪些类型的数据不能。

  2. 不同模块的标准头文件:
    为了更好地理解和维护代码,不同模块的头部应该遵循一些标准的格式和信息。标题格式必须包含以下各公司正在使用的内容:
    • 模块名称
    • 模块创建日期
    • 模块作者
    • 修改历史
    • 关于模块功能的模块概要
    • 模块支持的不同功能及其输入输出参数
    • 模块访问或修改的全局变量
  3. 局部变量、全局变量、常量和函数的命名约定:
    下面给出了一些命名约定:
    • 有意义且易于理解的变量名称可帮助任何人了解使用它的原因。
    • 局部变量应使用以小写字母开头的驼峰式字母命名(例如localData ),而全局变量名称应以大写字母开头(例如GlobalData )。常量名称应仅使用大写字母构成(例如CONSDATA )。
    • 最好避免在变量名称中使用数字。
    • 函数的名称应以小写字母开头的驼峰式大小写。
    • 函数名称必须清楚简要地描述使用该函数的原因。
  4. 缩进:
    适当的缩进对于提高代码的可读性非常重要。为了使代码可读,程序员应该正确使用空格。下面给出了一些间距约定:
    • 在两个函数参数之间给出逗号后必须有一个空格。
    • 每个嵌套块都应正确缩进和间隔。
    • 程序中每个块的开头和结尾都应该有适当的缩进。
    • 所有大括号都应从新行开始,大括号结尾后面的代码也应从新行开始。
  5. 错误返回值和异常处理约定:
    所有遇到错误条件的函数都应该返回 0 或 1 以简化调试。

    另一方面,编码指南给出了一些关于要遵循的编码风格的一般建议,以提高代码的可理解性和可读性。下面给出了一些编码指南:

  6. 避免使用难以理解的编码风格:
    代码应该易于理解。复杂的代码使维护和调试变得困难和昂贵。
  7. 避免将标识符用于多种用途:
    每个变量都应该有一个描述性和有意义的名称,表明使用它的原因。如果一个标识符被用于多种用途,这是不可能的,因此它会导致读者混淆。此外,它在未来的增强过程中会导致更多的困难。
  8. 代码应该有据可查:
    应正确注释代码以便于理解。关于语句的注释增加了代码的可理解性。
  9. 函数的长度不应很大:
    冗长的函数很难理解。这就是为什么函数应该足够小以执行小任务,而冗长的函数应该分解成小函数来完成小任务。
  10. 尽量不要使用 GOTO 语句:
    GOTO 语句使程序变得非结构化,从而降低了程序的可理解性,也使调试变得困难。

编码指南的优点:

  • 编码指南提高了软件的效率并减少了开发时间。
  • 编码指南有助于在早期阶段检测错误,因此有助于减少软件项目产生的额外成本。
  • 如果正确维护编码指南,则软件代码会增加可读性和可理解性,从而降低代码的复杂性。
  • 它降低了开发软件的隐性成本。