编码标准和准则介绍和详细指南

根据模块规范, 在编码阶段对设计文档中指定的不同模块进行编码。编码阶段的主要目标是使用高级语言从设计阶段后准备的设计文档中进行编码, 然后对该代码进行单元测试。
好的软件开发组织希望他们的程序员保持某种定义良好的标准编码风格, 即编码标准。他们通常根据最适合其组织的内容以及所开发软件的类型来制定自己的编码标准和准则。对程序员来说, 保持编码标准非常重要, 否则在代码审查期间, 代码将被拒绝。
制定编码标准的目的:

  • 编码标准使不同工程师编写的代码具有统一的外观。
  • 它提高了代码的可读性和可维护性, 还降低了复杂性。
  • 它有助于代码重用, 并有助于轻松检测错误。
  • 它促进了良好的编程习惯并提高了程序员的效率。
下面给出了一些编码标准:
全局变量的有限使用:
这些规则说明了可以声明为全局的数据类型和不能声明的数据。
不同模块的标准头:
为了更好地理解和维护代码, 不同模块的标头应遵循一些标准格式和信息。标头格式必须包含各种公司正在使用的以下内容:
  • 模块名称
  • 创建模块的日期
  • 模块作者
  • 修改历史
  • 有关模块功能的模块简介
  • 模块中支持的不同功能及其输入输出参数
  • 模块访问或修改的全局变量
局部变量, 全局变量, 常量和函数的命名约定:
下面给出了一些命名约定:
  • 有意义且易于理解的变量名可帮助任何人理解使用它的原因。
  • 局部变量应使用小写字母开头的驼峰字母来命名(例如localData), 而全局变量名称应以大写字母开头(例如全球数据)。常数名称应仅使用大写字母组成(例如CONSDATA)。
  • 最好避免在变量名中使用数字。
  • 函数名称应以小写字母大写。
  • 函数名称必须清楚, 简短地描述使用该函数的原因。
缩进:
适当的缩进对于提高代码的可读性非常重要。为了使代码可读, 程序员应适当使用空格。下面给出了一些间距约定:
  • 在两个函数参数之间加逗号后必须有一个空格。
  • 每个嵌套块应适当缩进并隔开。
  • 程序中每个程序段的开头和结尾都应有适当的缩进。
  • 所有花括号应从新行开始, 并且花括号末尾的代码也应从新行开始。
错误返回值和异常处理约定:
遇到错误情况的所有函数都应返回0或1以简化调试。
另一方面, 编码指南对应遵循的编码样式提供了一些一般性建议, 以提高编码的可读性和可读性。下面给出了一些编码准则:
避免使用太难理解的编码样式:
代码应该易于理解。复杂的代码使维护和调试困难且昂贵。
【编码标准和准则介绍和详细指南】避免将标识符用于多种目的:
应该为每个变量赋予一个描述性且有意义的名称, 以指示使用该变量的原因。如果将标识符用于多种目的, 则这是不可能的, 因此可能导致阅读器混乱。此外, 在将来的增强过程中会导致更多的困难。
代码应有据可查:
为了便于理解, 应该对代码进行适当的注释。有关语句的注释增加了代码的可理解性。
函数的长度不应太大:
冗长的功能很难理解。这就是为什么功能应该足够小以执行较小的工作, 而冗长的功能应该分解为小的功能以完成小的任务的原因。
尽量不要使用GOTO语句:
GOTO语句使程序变得非结构化, 从而降低了程序的可理解性, 并且调试变得困难。
编码准则的优点:
  • 编码准则可提高软件效率并减少开发时间。
  • 编码指南有助于在早期阶段检测错误, 因此有助于减少软件项目产生的额外成本。
  • 如果正确维护了编码准则, 则软件代码将提高可读性和可理解性, 从而降低代码的复杂性。
  • 它减少了开发软件的隐藏成本。

    推荐阅读