2025年鸿蒙编程入门pdf(鸿蒙编程入门)

鸿蒙编程入门pdf(鸿蒙编程入门)鸿蒙 NEXT 开发实战往期必看文章 一分钟了解 纯血版 鸿蒙 HarmonyOS Next 应用开发 非常详细的 鸿蒙 HarmonyOS Next 应用开发学习路线 从零基础入门到精通 HarmonyOS NEXT 应用开发案例实践总结合 持续更新 HarmonyOS NEXT 应用开发性能优化实践总结 持续更新



鸿蒙NEXT开发实战往期必看文章:

一分钟了解”纯血版!鸿蒙HarmonyOS Next应用开发!

“非常详细的” 鸿蒙HarmonyOS Next应用开发学习路线!(从零基础入门到精通)

HarmonyOS NEXT应用开发案例实践总结合(持续更新......)

HarmonyOS NEXT应用开发性能优化实践总结(持续更新......)


此规范基于业界通用的编程规范整理而成,请内核的开发人员遵守这样的编程风格。

总体原则:

  • 清晰:代码应当易于理解、易于维护、易于重构,避免晦涩语法

  • 简洁:命名简短,函数紧凑

  • 高效:通过使用算法、编译器优化选项或硬件资源提高程序效率

  • 美观:代码风格合理、一致

在大部分情况下,开发人员应当遵从以下规范,但也有一些例外场景。如修改第三方开源代码或大量使用开源代码接口下,应当与开源代码保持一致。请依据总体原则,灵活处理。

建议按照功能模块划分子目录,子目录再定义头文件和源文件目录。

目录名和文件名如果没有特殊的需要,采用全小写的形式,可以使用下划线(“_”)分割。

推荐使用驼峰风格,具体规则如下:

类型命名风格形式函数、结构体类型、枚举类型、联合体类型、typedef的类型大驼峰,或带有模块前缀的大驼峰AaaBbb
XXX_AaaBbb局部变量,函数参数,宏参数,结构体中字段,联合体中成员小驼峰aaaBBB全局变量带“g_”前缀的小驼峰g_aaaBBB宏(不含函数式宏),枚举值,goto标签全大写,下划线分割AAA_BBB函数式宏全大写下划线分割,或大驼峰,或带有模块前缀的大驼峰AAA_BBB
AaaBbb
XXX_AaaBbb头文件防止重复的符号以下划线“_”开头以H结尾,中间为文件名的全大写并以下划线分割_AAA_H

内核对外API建议采用LOS_ModuleFunc的形式,如果有宾语则建议采用前置的方式,比如:

 

kernel目录下内部模块间的接口使用OsModuleFunc的形式,比如:

 
 

一般的,尽量通过清晰的软件架构,良好的符号命名来提高代码可读性;在需要的时候,辅以注释说明。

注释是为了帮助阅读者快速读懂代码,所以要从读者的角度出发,按需注释。

注释内容要简洁、明了、无歧义,信息全面且不冗余。

文件头部要进行注释,建议注释列出:版权说明、文件功能说明,作者、创建日期、注意事项等。

注释风格要统一,建议优先选择/* */的方式,注释符与注释内容之间要有1空格,单行、多行注释风格如下:

 

针对代码的注释,应该置于对应代码的上方或右方。

代码上方的注释,与代码行间无空行,保持与代码一样的缩进。

代码右边的注释,与代码之间,至少留1空格。

建议将多条连续的右侧注释对齐,比如:

 
 

程序采用缩进风格编写,使用空格而不是制表符(’ ’)进行缩进,每级缩进为4个空格。

换行时,函数左大括号另起一行放行首,并独占一行;其他左大括号跟随语句放行末。右大括号独占一行,除非后面跟着同一语句的剩余部分,如 do 语句中的 while,或者 if 语句的else/else if,或者逗号、分号。

一行只写一条语句。

比如:

 

每行字符数不要超过 120 个,代码过长时应当换行,换行时将操作符留在行末,新行缩进一层或进行同类对齐,并将表示未结束的操作符或连接符号留在行末。

 

包括 if/for/while/do-while 语句应使用大括号,即复合语句。

 

case/default 语句相对 switch 缩进一层,风格如下:

 

指针类型"*"跟随变量或者函数名,例如:

 
 

定义函数式宏前,应考虑能否用函数替代。对于可替代场景,建议用函数替代宏。对于有性能需求的场景,可以使用内联函数。

定义宏时,要使用完备的括号,例如:

 

以下情况需要注意:

  • 宏参数参与 ‘#’, ‘##’ 操作时,不要加括号;

  • 宏参数参与字符串拼接时,不要加括号;

  • 宏参数作为独立部分,在赋值(包括+=, -=等)操作的某一边时,可以不加括号;

  • 宏参数作为独立部分,在逗号表达式,函数或宏调用列表中,可以不加括号。

 

包含多条语句的函数式宏的实现语句必须放在 do-while(0)中。

禁止把带副作用的表达式作为参数传递给函数式宏,比如自加操作(“a++”)。

函数式宏定义中慎用 return、goto、continue、break 等改变程序流程的语句。

禁止宏调用参数中出现预编译指令,如#include,#define和#ifdef,这样做会导致未定义的行为。

宏定义不以分号结尾。

头文件应当职责单一。

通常情况下,每个.c文件都应有一个相应的.h文件(并不一定同名),用于放置对外提供的函数声明、宏定义、类型定义等。如果不需要提供对外接口,可以没有对应的.h文件。

避免头文件循环依赖,如a.h 包含 b.h,b.h 包含 c.h,c.h 包含 a.h。

头文件应当自包含,即包含某个头文件,不需要引入其他头文件就可以编译。

头文件用#define、#ifndef、#endif保护,防止重复包含;不要使用 #pragma once。

禁止通过声明的方式引用外部函数接口、变量,只能通过包含头文件的方式使用其他模块或文件提供的接口。

建议按稳定度包含头文件,依次顺序为: 源码对应的头文件,C标准库,操作系统库,平台库,项目公共库,自己其他的依赖。

基础数据类型建议使用los_compiler.h中定义的类型,比如无符号32位整数位定义为UINT32。

避免大量栈分配,如较大的局部数组。

谨慎使用全局变量,尽量不用或少用全局变量。

变量应当初始化后再使用。

禁止将局部变量的地址返回到其作用域以外。

指向资源句柄或描述符的变量,在资源释放后立即赋予新值(如果变量的作用域马上结束可以不赋予新值)。指向资源句柄或描述符的变量包括指针、文件描述符、socket描述符以及其它指向资源的变量。

断言必须使用宏定义,且只能在调试版本中生效。

断言应当看作设计约束,禁止用断言检测程序在运行期间可能导致的错误,可能发生的错误要用错误处理代码来处理。

禁止在断言内改变运行环境。

一个断言只用于检查一个错误。

由一个进程向另一个进程发送的数据、由应用向内核发送的数据等应当进行合法性校验,校验包括但不限于:

  • 校验数据长度

  • 校验数据范围

  • 校验数据类型和格式

  • 校验输入只包含可接受的字符(“白名单”形式)

函数应避免使用全局变量、静态局部变量和直接的I/O操作,不可避免时,应当对读写操作进行封装。

编程小号
上一篇 2025-03-05 15:33
下一篇 2025-02-26 09:27

相关推荐

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。
如需转载请保留出处:https://bianchenghao.cn/bian-cheng-ri-ji/50149.html