diff --git a/zh-cn/design/hdi-design-specifications.md b/zh-cn/design/hdi-design-specifications.md index 03d9969594a2482bbb2e4c44fb7608309e4f6c51..5b20dd0799214d46a45197f8a4eb3b87b6628c3c 100644 --- a/zh-cn/design/hdi-design-specifications.md +++ b/zh-cn/design/hdi-design-specifications.md @@ -14,11 +14,11 @@ **用词约定:** -规则:必须遵守的约定 +规则:必须遵守的约定。 -建议:需要加以考虑的约定 +建议:需要加以考虑的约定。 -说明:对此规则或建议进行相应的解释 +说明:对此规则或建议进行相应的解释。 **文档变更说明:** | 版本 | 变更说明 | @@ -132,7 +132,7 @@ Table 1 接口评审&管控角色 - 对废弃接口增加标识废弃标记。 - - 废弃HDI至少保留4个OpenHarmony API版本 + - 废弃HDI至少保留4个OpenHarmony API版本。 ## 接口设计约束 @@ -158,7 +158,7 @@ Table 1 接口评审&管控角色 int (*OpenLayer)(uint32_t devId, const LayerInfo *layerInfo, uint32_t *layerId); ``` -在调用OpenLayer接口时,根据入参layerInfo创建图层数据内存,并返回layerId +在调用OpenLayer接口时,根据入参layerInfo创建图层数据内存,并返回layerId; ```cpp int (*CloseLayer)(uint32_t devId, uint32_t layerId); @@ -216,14 +216,14 @@ void WriteReady(); #### 【规则】类、结构体、接口方法、参数等采用驼峰命名风格 __驼峰风格(CamelCase)__ 大小写字母混用,单词连在一起,不同单词间通过单词首字母大写来分开。 -按连接后的首字母是否大写,又分: 大驼峰(UpperCamelCase)和小驼峰(lowerCamelCase) +按连接后的首字母是否大写,又分: 大驼峰(UpperCamelCase)和小驼峰(lowerCamelCase)。 | 类型 | 命名风格 | | ---------------------------------------- | --------- | | 接口类型,接口方法,结构体类型,枚举类型,联合体类型等类型定义 | 大驼峰 | | 函数参数,结构体和联合体中的成员变量 | 小驼峰 | -| 常量,枚举值 | 全大写,下划线分割 | +| 常量,枚举值 | 全大写,以下划线分割 | #### 【规则】接口文件应与接口类同名且使用'.idl'文件后缀 - 每个接口类应定义在独立的接口文件中,并使文件命名与接口类保持一致(大驼峰命名),并以`.idl`后缀结尾。