没有合适的资源?快使用搜索试试~ 我知道了~
首页华为2019编程规范详解:C/C++编码指南
华为代码规范2019文档是一份专为规范软件开发人员的编码实践而编写的指南,它提供了2019年的最新版本,旨在统一和提升代码质量。这份文档针对C/C++编程语言,同时也适用于Java等其他编程语言,强调了代码编写的一致性和可读性。 文档的核心内容包括: 1. 概述:文档的主要目的是为了确保所有开发者在编码过程中遵循共同的标准,减少因个人习惯导致的混乱,提高代码的可维护性和团队协作效率。 2. 文档约定:文档中定义了特定术语和缩写词,以便读者理解和使用,确保沟通的一致性。例如,"valid_ni"和"repssn_index"等术语可能具有特定的含义和用法。 3. 预期读者与阅读建议:这份规范适用于软件开发的各个层次,无论是初级开发者还是经验丰富的专家,都应当参照此规范进行编码。它鼓励读者在编写代码时始终保持清晰的思维,并关注代码的可读性。 4. 排版要求:文档强调了代码的结构和格式,如使用4个空格的缩进风格,保持程序块之间的清晰分隔,避免长语句过长不易理解,例如通过换行和适当缩进来分割长表达式。 5. 示例:文档提供了具体的代码片段,展示如何按照规范书写,比如在if语句后添加空行,以及如何处理长表达式的换行规则。这些示例帮助开发者直观地理解并应用规范。 6. 循环和判断表达式的处理:在编写含有循环或条件判断的代码时,规范要求遵循一定的格式,确保代码逻辑的清晰和易于理解。 华为代码规范2019是一个实用的参考工具,它不仅规定了编码的最佳实践,还通过详细的规则和实例教导开发者如何写出高质量、易读且可维护的代码。遵循这样的规范,能够提升整个团队的编码水平,降低后期维护成本,是提升软件开发质量和效率的重要手段。
资源详情
资源推荐
第 11 页 共 69 页
a = b ^ 2;
(3)"!"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格。
*p = 'a'; // 内 容 操 作 "*" 与 内 容 之 间
flag = !isEmpty; // 非操作"!"与内容之间
p = &mem; // 地址操作"&" 与内容之间 i+
+; // "++","--"与内容之间
(4)"->"、"."前后不加空格。
p->id = pid; // "->"指针前后不加空格
(5) if、for、while、switch 等与后面的括号间应加空格,使 if 等关键字更为突出、明显。
if (a >= b && c > d)
2.12其他
2.12.1 一行程序以小于 80 字符为宜,不要写得过长。
3 注释
3.1 有效注释量
一般情况下,源程序有效注释量必须在 20%以上。
说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不
能太少,注释语言必须准确、易懂、简洁。
3.2 公司标识
在头文件中加入公司标识。
示例如下:
**************************************************************************/
/*
第 12 页 共 69 页
*/
/* Copyright (c) 1996-1998 XXXXXX Company */
/* xxxxxxxx 版权所有 1996-1998 */
/*
*/
/* PROPRIETARY RIGHTS of XXXXXX Company are involved in the
*/
/* subject matter of this material. All manufacturing, reproduction, use,*/
/* and sales rights pertaining to this subject matter are governed by the */
/* license agreement. The recipient of this software implicitly accepts */
/* the terms of the
license.
*/
/* 本软件文档资料是 xxx 公司的资产,任何人士阅读和使用本资料必须获得 */
/* 相应的书面授权,承担保密责任和接受相应的法律约
束. *
/
/*
*/
/**************************************************************************/
3.3 说明性文件
说明性文件(如头文件.h 文件、.inc 文件、.def 文件、编译说明文件.cfg 等)头部应进行注释,注释
必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的
注释中还应有函数功能简要说明。
示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/*************************************************
Copyright (C), 1996-1998, xxxxx. Co., Ltd.
File name: // 文件名
Author: Version: Date: // 作者、版本及完成日期
Description: // 用于详细说明此程序文件完成的主要功能,与其他模块
// 或函数的接口,输出值、取值范围、含义及参数间的控
// 制、顺序、独立或依赖等关系
Others: // 其它内容的说明
Function List: // 主要函数列表,每条记录应包括函数名及功能简要说明
1. ....
History: // 修改历史记录列表,每条修改记录应包括修改日期、修改
// 者及修改内容简述
第 13 页 共 69 页
1. Date:
Author:
Modification:
2. ...
*************************************************/
3.4 源文件头
源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及
其功能、修改日志等。
示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/************************************************************
Copyright (C), 1988-1999, Xxxxxx Tech. Co., Ltd.
FileName: test.cpp
Author: Version : Date:
Description: // 模块描述
Version: // 版本信息
Function List: // 主要函数及其功能
1. -------
History: // 历史修改记录
<author> <time> <version > <desc>
David 96/10/12 1.0 build this moudle
***********************************************************/
说明:Description 一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关
系等。History 是修改历史记录列表,每条修改记录应包括修改日期、修改者及修改内容简述。
3.5 函数头部说明
函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、
表)等。
示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/*************************************************
Function: // 函数名称
剩余63页未读,继续阅读
鲁峰2012
- 粉丝: 13
- 资源: 14
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
- 十种常见电感线圈电感量计算公式详解
- 军用车辆:CAN总线的集成与优势
- CAN总线在汽车智能换档系统中的作用与实现
- CAN总线数据超载问题及解决策略
- 汽车车身系统CAN总线设计与应用
- SAP企业需求深度剖析:财务会计与供应链的关键流程与改进策略
- CAN总线在发动机电控系统中的通信设计实践
- Spring与iBATIS整合:快速开发与比较分析
- CAN总线驱动的整车管理系统硬件设计详解
- CAN总线通讯智能节点设计与实现
- DSP实现电动汽车CAN总线通讯技术
- CAN协议网关设计:自动位速率检测与互连
- Xcode免证书调试iPad程序开发指南
- 分布式数据库查询优化算法探讨
- Win7安装VC++6.0完全指南:解决兼容性与Office冲突
- MFC实现学生信息管理系统:登录与数据库操作
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功