没有合适的资源?快使用搜索试试~ 我知道了~
这是一份编程规范,是华为的编程规范。共大家参考。对代码编写风格已经注意事项做详细说明和规定。
资源推荐
资源详情
资源评论
〔一〕排版
¹1-1:程序块要采用缩进风格编写,缩进的空格数为 4个
说明:对于由开发工具自动生成的代码可以有不一致。
¹1-2:相对独立的程序块之间、变量说明之后必须加空行
示例:如下例子不符合规范。
应如下书写
¹1-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划
分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可
读
示例:
!"#$%#&%'%()*+,#-"%.)"
/&%'%&01)()*2*'+34-.
563&%'%%'&7,8),7"-+9)*/
565
&:&
;5<+'=',%%'&7"-+9)*
>>$
>>565 ?
¹1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式
要在低优先级操作符处划分新行,操作符放在新行之首
示例:
5<5 6
>>$
?@A?<9 B7CDDD!
>>A<"D7CDD!//@A//
?@A?
<ED!>>A<D!
//@A//
¹1-5:若函数或过程中的参数较长,则要进行适当的划分
示例:
$9:%)3>6A@
9:%)3>5656A@
4&%'%#9F),%
$;! @3&%'%%'&7,8),7"-+9)*
/@6A
¹1-6:不允许把多个短语句写在一行中,即一行只写一条语句
示例:如下例子不符合规范。
!?D!?
应如下书写
!?
D!?
¹1-7:if、for、do、while、case、switch、default等语句自占一行,且
if、for、do、while等语句的执行语句部分无论多少都要加括号{}
示例:如下例子不符合规范。
-,*"-..
应如下书写:
-,*"-..
¹1-8:对齐只使用空格键,不使用 TAB键
说明:以免用不同的编辑器阅读程序时,因 %'9 键所设置的空格数目不同而造成程序布
局不整齐
¹1-9:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,
case语句下的情况处理语句也要遵从语句缩进要求
¹1-10:程序块的分界符(如 C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于
同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚
举的定义以及 if、for、do、while、switch、case语句中的程序都要采用如上
的缩进方式
示例:如下例子不符合规范。
应如下书写。
¹1-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、
之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),
后不应加空格。
说明:采用这种松散方式编写代码的目的是使代码更加清晰
由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空
格,如果语句已足够清晰则括号内侧即左括号后面和右括号前面不需要加空格,多重括
号间不必加空格,因为在 ,,//语言中括号已经是最清晰的标志了。
在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。
给操作符留空格时不要连续留两个以上空格。
示例:
G逗号、分号只在后面加空格。
@6@
H比较操作符@赋值操作符II、I/I,算术操作符I/I、IJI,逻辑操作符I>
>I、I>I,位域操作符I<<I、IKI等双目操作符的前后加空格。
L+'=%0+)M'.-)
6/
3H
6KH
NII、IOI、I//I、IPPI、I>I(地址运算符)等单目操作符前后不加空格。
3QQ内容操作I3I与内容之间
;)C非操作II与内容之间
>地址操作I>I与内容之间
//I//I@IPPI与内容之间
RIPLI、II前后不加空格。
PLIPLI指针前后不加空格
S、、D!、D! 等与后面的括号间应加空格,使 等关键字更为突出、明显。
L6>>L
TGPG:一行程序以小于 U? 字符为宜,不要写得过长。
〔二〕注释
¹2-1:一般情况下,源程序有效注释量必须在 20%以上
说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也
不能太少,注释语言必须准确、易懂、简洁。
¹2-2:说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg
等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功
能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明
示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议
要包含在内。
3333333333333333333333333333333333333333333333333
,C!,@GVUUPGVVV@8 D%!,@.
2W文件名
' !WMWXW作者、版本及完成日期
XW用于详细说明此程序文件完成的主要功能,与其他模块
或函数的接口,输出值、取值范围、含义及参数间的控
制、顺序、独立或依赖等关系
#!W其它内容的说明
2 .W主要函数列表,每条记录应包括函数名及功能简要说明
G
8CW修改历史记录列表,每条修改记录应包括修改日期、修改
者及修改内容简述
GXW
' !W
+EW
H
3333333333333333333333333333333333333333333333333
YHPN:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的
功能、主要函数及其功能、修改日志等。
示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议
要包含在内。
333333333333333333333333333333333333333333333333333333333333
,C!,@GVUUPGVVV@8 D%!,@.
2"W
' !WMWXW
XW模块描述
MW版本信息
2 .W主要函数及其功能
GPPPPPPP
8CW历史修改记录
< !L<L<L<L
XVZG?GHG?6 !
33333333333333333333333333333333333333333333333333333333333
说明:X 一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其
它文件关系等。8C 是修改历史记录列表,每条修改记录应包括修改日期、修改者及
修改内容简述。
¹2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、
调用关系(函数、表)等
示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包
含在内。
3333333333333333333333333333333333333333333333333
2 W函数名称
XW函数功能、性能等的描述
,W被本函数调用的函数清单
剩余40页未读,继续阅读
资源评论
fengksz
- 粉丝: 0
- 资源: 5
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功