程序代码要求怎么写

时间:2025-01-28 14:17:47 单机游戏

编写程序代码时,应遵循以下要求和规范:

排版

关键词和操作符之间加适当的空格。

相对独立的程序块与块之间加空行。

较长的语句、表达式等要分成多行书写。

划分出的新行要进行适应的缩进,使排版整齐,语句可读。

长表达式要在低优先级操作符处划分新行,操作符放在新行之首。

循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分。

若函数或过程中的参数较长,则要进行适当的划分。

不允许把多个短语句写在一行中,即一行只写一条语句。

函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。

C/C++语言是用大括号“{”和“}”界定一段程序块的,编写程序块时“{”和“}”应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

可读性

可读性第一,效率第二。

保持注释与代码完全一致。

每个源程序文件,都有文件头说明,说明规格见规范。

每个函数,都有函数头说明,说明规格见规范。

主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义。

常量定义(DEFINE)有相应说明。

处理过程的每个阶段都有相关注释说明。

在典型算法前都有注释。

利用缩进来显示程序的逻辑结构,缩进量一致并以Tab键为单位,定义Tab为6个字节。

循环、分支层次不要超过五层。

注释可以与语句在同一行,也可以在上行。

空行和空白字符也是一种特殊注释。

结构化

禁止出现两条等价的支路。

禁止GOTO语句。

用IF语句来强调只执行两组语句中的一组。禁止ELSE GOTO和ELSE RETURN。

用CASE实现多路分支。

避免从循环引出多个出口。

函数只有一个出口。

其他

尽量使用接口,然后使用类实现接口,以提高程序的灵活性。

一行不要超过80个字符。

尽量不要手工更改计算机生成的代码,若必须更改,一定要改成和计算机生成的代码风格一样。

关键的语句(包括声明关键的变量)必须要写注释。

建议局部变量在最接近使用它的地方声明。

不要使用goto系列语句,除非是用在跳出深层循环时。

避免写超过5个参数的方法。如果要传递多个参数,则使用结构。

避免书写代码量过大的try…catch模块。

避免在同一个文件中放置多个类。

生成和构建一个长的字符串时,一定要使用StringBuilder类型,而不是string类型。

switch语句一定要有default语句来处理意外情况。

对于if语句,应该使用一对“{ }”把语句块包含起来。

尽量不使用this关键字引用(this一般表示类的当前实例)。

这些规范有助于提高代码的可读性、可维护性和可扩展性,使代码更加清晰、简洁和高效。在编写代码时,建议遵循这些规范,并根据具体项目的需求进行适当的调整。