ohos-design-c-api-review
Installation
SKILL.md
鸿蒙C API规范检视
本技能用于检视鸿蒙C API接口设计是否符合规范。涵盖命名、接口设计、指针/缓冲区、异常处理、类型数据、注释、结构定义等方面的规范要求。
检视时,对每个API声明逐一检查所有适用规则。一个API可能同时存在命名、注释、参数、错误码等多类违规,不要只检最明显的问题。检查命名前先扫描同文件已有API的命名模式;检查注释时关注是否有复制粘贴导致的描述不匹配。反馈应包含具体的参数名、类型建议,而非笼统描述。
命名规范
符合命名规范 [规则]
API命名要贴合业务场景,准确表达核心功能。业界有通用命名习惯的保持一致。对于多个候选词或表达方式均准确的,优先保持和存量接口风格一致。
命名使用肯定表达式 [规则]
IsNot*应改为IsDisabled/IsHidden等;IsUn*如IsUnavailable应改为IsAvailable。对仗函数(Unsubscribe/Unregister)无需修改。Disable/Hide/Close不是否定词。
命名必须使用英语 [规则]
禁止使用拼音或其他非英语语言。
禁止出现语法词法错误 [规则]
注意单词拼写、词性搭配、动词时态。业界通用惯例可例外。