关于 openharmony-cpp
openharmony-cpp 是面向 OpenHarmony C++ 开发的技能,适用于编写、重构和审查代码。它集中说明该平台的命名、格式、头文件管理及安全编码要求。
主要功能
- 01OpenHarmony 命名与格式规范
- 02头文件与包含规则
- 03输入校验要求
- 04内存与位运算安全规则
适用场景
- 01按 OpenHarmony 规范生成类或模块
- 02整理遗留 C++ 代码
- 03检查代码是否符合规范
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ openharmonyinsight/ openharmony-skills --skill openharmony-cpp安装后在 Claude Code 中输入/openharmony-cpp确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/class_function_design.mdheaders_scopes.mdnaming_formatting.mdsecure_coding.md详细介绍
OpenHarmony C++ 编码规范
核心要求(常见陷阱)
这些规则在 OpenHarmony 中严格执行,且通常与通用 C++ 项目不同。
1. 严格的命名与格式规范
- **扩展名:**始终使用
.cpp和.h。 - 文件:文件名必须与类名匹配(类 Unix 风格,例如
my_class.cpp)。 - **变量:**全局变量必须以
g_开头(例如g_config)。类成员必须以_结尾(例如value_)。 - 大括号:****必须采用 K&R 风格(左大括号与声明位于同一行)。
- **详情:**参见 naming_formatting.md。
2. 头文件管理
- **保护宏:**使用
#ifndef保护宏。严禁使用 #pragma once。 - **包含:**优先使用
#include,而非前向声明,以避免隐藏依赖。 - **详情:**参见 headers_scopes.md。
3. 关键安全要求
- **输入验证:**使用外部数据前,必须验证所有数据(索引、大小、循环)。
- 内存安全:删除指针后,必须立即将其设为
nullptr。 - 位运算:仅用于无符号类型。
- **详情:**参见 secure_coding.md。
使用指南
适用场景
- **编写新代码:**生成新类或模块。
- **重构:**整理旧代码。
- **代码审查:**检查代码是否符合 OpenHarmony 标准。
参考索引
- naming_formatting.md:命名约定(g_、_)、大括号(K&R)、行长度。
- secure_coding.md:输入验证、整数安全、内存管理、禁用函数。
- class_function_design.md:构造函数、继承、现代 C++(nullptr、const)、函数长度。
- headers_scopes.md:头文件保护宏、命名空间、包含规则。
评论
支持 Markdown