华为编程规范

华为编程规范,第1张

华为编程规范举例:

1-1:程序块要采用缩进风格编写,缩进的空格数为4个。

说明:对于由开发工具自动生成的代码可以有不一致。

1-2:相对独立的程序块之间、变量说哪拍滚明之后必须加空行。

1-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级 *** 作符处划分新行, *** 作符放在新行贺伏之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。

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

1-5:if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等李余语句的执行语句部分无论多少都要加括号{}。

1-6:对齐只使用空格键,不使用TAB键。

说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐,不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键,因此使用BC合入的版本大多会将缩进变乱。

1-7:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。

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

1-9:一行程序以小于80字符为宜,不要写得过长。

2-1:一般情况下,源程序有效注释量必须在20%以上。

说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。

2-2:文件头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、修改日志等。

示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

2-3:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。

示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。

2-4:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。

2-5:注释的内容要清楚、明了,含义准确,防止注释二义性。

说明:错误的注释不但无益反而有害。

2-6:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。

2-7:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。

2-8:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。

2-9:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

2-10:注释与所描述内容进行同样的缩排。

说明:可使程序排版整齐,并方便注释的阅读与理解。

2-11:避免在一行代码或表达式的中间插入注释。

说明:除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。

2-12:通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。

说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。

2-13:在代码的功能、意图层次上进行注释,提供有用、额外的信息。

说明:注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。

您可以通过以下两种方式获取:

进入华为官网点击用户手册下载,根据手机型号搜索并下载对应的说明书。

在桌面上,点击“手机服务 >手册”即可查看用户手册。

用户手册的内容

编写内容要求如下。

(1)引言

①编写目的:阐明编写手册的目的,指明读者对象。

②项目背景:说明项目的来源、委托单位、开发单位及主管部门。

③定义:列出手册中用到的专门术语定义和缩写词的原意。

④参考资料:列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源,包括项目的计划任务书,合同或批文;项目开发计划;需求规格说明书;概要设计说明书;详细设计说明书;测试计划;手册中引用的其他资料、采用的软件工程标准或软件工程规范。

(2)软件概述

①目标。

②功能。

③性能。包括数据精确度(包括输入、输出及处理数据的精度),时间特性(如响应时间、处理时间、数据传输时问等),灵活性(在 *** 作方式、运行环境需做某些变更时软件的适应能力)。

(3)运行环境

①硬件:列出软件系统运行时所需的硬件最小配置,如计算机型号、主存容量;外存储器、媒体、记录格式、设备型号及数量; 输入、输出设备;数据传输设备及数据转换设备的型号及数量。

②支持软件: *** 作系统名称及版本号;语言编译系统的名称及版本号;数据库管理系统的名称及版本号;其他必要的支持软件。

(4)使用说明

①安装和初始化:给出程序的存储形式、 *** 作命令、反馈信息及其含义、表明安装完成的测试实例以及安装所需的软件开发工具等。

②输入:给出输入数据或参数的要求。

③输出:给出每项输出数据的说明。

④出错和恢复:出错信息及其含义、用户应采取的措施,如修改、恢复、再启动等。

⑤求助查询:说明如何 *** 作。

(5)运行说明

①运行表:列出每种可能的运行情况,说明其运行目的。

②运行步骤:按顺序说明每种运行的步骤,应包括运行控制; *** 作信息(运行目的、 *** 作要求、启动方法、预计运行时间、 *** 作命令格式及说明、其他事旅纯哪项);输入/输出文件(给出建立和更新文件的有关信息,如文件的名称及编号、记录媒体、存留的目录、文件的支配[说明确定保留文件或废弃文件的准则,分发文件的对象,占用硬件的优先级及保密控制等]);启动或恢复过程。

(6)非常规过程:提供应急或非常规 *** 作的必要信息及 *** 拆码作步骤,如出错处理 *** 作、向后备系统切换 *** 作以及维护人员须知的 *** 作和注意事项。

(7) *** 作命令一览表:按字母顺序逐个列出全部 *** 作命令的格式、功能及参数说明。裤睁

(8)程序文件(或命令文件)和数据文件一览表:按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。

(9)用户 *** 作举例。

一、Appmakr

AppMakr是一个可以让你在几分钟之内创建应用程序的一种服务,无需编码能力。使用该工具,你可以创建iPhone和Android应用。还有一些可供选择的功能,包括将网站连接到你的应用程序、HTML5功能、推送通知和广告支持。通过AppMaker账户,你可以创建无限数量的应用程序。目前Appmakr是国外比较流行的应用生成工具,在国内也享有一定知名度。

二、AppCan

AppCan属于移动应用开发平台,应用引擎支持HybridApp的开发和运行。并且着重解决了基于HTML5的移动应用目前"不流畅"和"体验差"的问题。使用AppCan应用引擎提供的Native交互能力,可以让HTML5开发的移动应用基本接近NativeApp的体验。

与Phonegap支持单一webview使用div为单位开发移动应用不同。AppCan支持多窗口机制,让开发者可以像最传统的网页开发一样,通过页面链接的方式灵活的开发移动应用。基于这种机制,开发者可以腔岩开发出大型的移动应用,而不是只能开发埋闭简易类型的移动应用。

三、appBook

appBook平台是伍液御多平台移动应用制作工具,可以广泛用于书籍制作,个人杂志发行,宣传手册,支持iPad、iPhone、Andriod等平台,不支持pc平台。真正做到了一次编译多平台发布。目前appbook平台有:iebook平台、及、appbook应用制作平台。


欢迎分享,转载请注明来源:内存溢出

原文地址:https://54852.com/yw/12553542.html

(0)
打赏 微信扫一扫微信扫一扫 支付宝扫一扫支付宝扫一扫
上一篇 2025-08-26
下一篇2025-08-26

发表评论

登录后才能评论

评论列表(0条)

    保存