Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
4f1abbc7
D
Docs
项目概览
OpenHarmony
/
Docs
9 个月 前同步成功
通知
158
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
前往新版Gitcode,体验更适合开发者的 AI 搜索 >>
未验证
提交
4f1abbc7
编写于
7月 31, 2023
作者:
Z
zengyawen
提交者:
Gitee
7月 31, 2023
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add native template
Signed-off-by:
N
zengyawen
<
zengyawen1@huawei.com
>
上级
999b47b7
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
120 addition
and
0 deletion
+120
-0
zh-cn/contribute/template/native-template.md
zh-cn/contribute/template/native-template.md
+120
-0
未找到文件。
zh-cn/contribute/template/native-template.md
0 → 100644
浏览文件 @
4f1abbc7
# Native接口文档注释
> **说明:**
>
> Native API文档由中文头文件生成,中文头文件应遵循以下注释规范才能生成对应文档。
## Module的注释
```
/**
* @addtogroup 模块名
* @{
*
* @brief 一句话描述该库的作用。(请使用动宾结构,如:实现XX功能。)
*
* 详细描述该模块的主要功能、使用场景和使用建议。尤其对这个模块中涉及的逻辑概念,相互关系,在应用中的作用进行说明。
* 比如AOSP中的Choreographer,介绍下这个概念的功能;然后介绍下简单的使用方法
* Choreographer,负责编排帧渲染时间,是java版本的C实现,应用可以利用这个机制安排帧的合理绘制时间点。接口使用
* 1. 注册一个回调函数到这个Choreographer,下一帧的时候调用
* 2. 在下一帧开始的时候,回调被调用,参数会带一个系统返回的FrameCallbackData
* 3. 回调中可以做的处理
* 4. sf根据回调的返回值,进行转换处理
* 详细描述中,如果有多个段落,每段必须以“\n”结束。\n
*
* @since OS的版本号
*/
...
/** @} */ (如果需要将头文件中具体函数划分到该模块中,则在文件最后加上/** @} */ )
```
## 文件File的注释
```
/**
* @file 头文件名
*
* @brief 一句话简要描述该头文件的作用。
*
* 详细描述该类或接口的主要功能、使用场景和使用建议。覆盖该类的主要功能、使用场景和使用建议。尤其对这个类涉及的逻辑概念,相互关系,在应用中的作用进行说明。\n
* 详细描述中,如果有多个段落,每段必须以“\n”结束。\n
* @library 引用头文件接口,需要链接的so名字
* @since OS的版本号
*/
```
## 宏定义/变量/常量的注释
```
/**
* @brief 一句话简要描述该宏定义/常量/变量的含义。
*
* 详细描述该宏定义/常量/变量的作用、使用限制和建议、取值范围,以及取到边界值、非法值的后果。\n
* 详细描述中,如果有多个段落,每段必须以“\n”结束。\n
*
* @deprecated (可选)标记位废弃的接口,需要加上这个标记,并写明从什么版本开发废弃,使用什么接口代替
* @since OS的版本号
*/
```
## 结构体Struct和联合体Union的注释
```
/**
* @brief 一句话简述该结构体或联合体的作用。
*
* 详细描述该结构体或联合体的作用、使用场合和建议等。\n
* 详细描述中,如果有多个段落,每段必须以“\n”结束。\n
*
* @deprecated (可选)标记位废弃的接口,需要加上这个标记,并写明从什么版本开发废弃,使用什么接口代替
* @since OS的版本号
*/
struct StructName {
/** 描述成员1的含义。 */
unsigned long StructMember1;
/** 描述成员2的含义。 */
unsigned long StructMember2;
};
```
## 枚举Enum的注释
```
/**
* @brief 一句话简述该枚举的作用。
*
* 详细描述该枚举的主要功能、使用场景和使用建议。\n
* 详细描述中,如果有多个段落,每段必须以“\n”结束。\n
*
* @deprecated (可选)标记位废弃的接口,需要加上这个标记,并写明从什么版本开发废弃,使用什么接口代替
* @since OS的版本号
*/
enum EnumName {
/** 描述枚举值1的含义 */
EnumMermber1,
/** 描述枚举值2的含义 */
EnumMermber2,
/** 描述枚举值3的含义 */
EnumMermber3
};
```
## 函数Function的注释
```
/**
* @brief 一句话简述该函数的作用。
*
* 详细描述该函数的主要功能、使用场景和使用建议。\n
* 详细描述中,如果有多个段落,每段必须以“\n”结束。\n
*
* @param (可选)后接参数名和参数描述,一个参数使用一个@param标记。参数描述写作要点:1.参数的作用、使用限制和建议;2.参数的取值范围,以及取到边界值、非法值的后果;3.如果存在参数设置方面的建议值或经验值,请描述。如果该方法没有参数,则请删除该标记。
* @return (可选)后接返回描述。如果该函数没有返回值,则请删除该标记。
* @see (可选)当存在与该函数相关联的函数时(功能相近或者存在关系),可以通过@see建立到参考函数的链接。如果需要链接多个函数,每个函数使用一个@see标记。如果不涉及,则请删除该标记。
* @permission (可选)对权限有要求的接口需要写
* @deprecated (可选)标记位废弃的接口,需要加上这个标记,并写明从什么版本开发废弃,使用什么接口代替
* @since OS的版本号
*/
```
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录