# SERVICE框架生成工具VS code插件说明

## 简介

SERVICE框架生成工具，根据用户提供的.h头文件，工具会自动生成整个Service框架的代码。目前工具支持VS Code插件一种入口，本文主要介绍VS Code插件说明。

## 目录

	├── napi_generator/src/vscode_plugin/h2sa                # SERVICE框架生成工具
	│   ├── service_vs_plugin                                # VS Code插件代码
	│   │   ├── docs                                         # VS Code插件说明
	│   │   ├── src    				                         # VS Code插件源码
	│   │   ├── package.json    	                         # package.json 文件
	│   │   └── README_zh.md                                 # VS Code插件说明

## 约束

系统：建议Ubuntu 20.04或者Windows 10

依赖版本：VS Code 1.62.0

## 使用方法

### 使用对象

系统开发者

### 使用场景

开发者为OpenHarmony系统框架开发某些功能，并将该功能包装成一个独立的服务进程运行在系统中。

### 工具使用

#### VS Code插件使用方法

具体的插件使用步骤，可以左键单击以下链接了解：

[VS插件使用说明](https://gitee.com/openharmony/napi_generator/tree/master/src/vscode_plugin/h2sa/service_vs_plugin/docs/usage/INSTRUCTION_ZH.md)

### 工具输出

根据使用者指定的.h头文件，工具会输出SERVICE框架代码。为了方便使用者快速上手工具，可供测试的.h文件如下所示：

```
#ifndef TEST_H
#define TEST_H

namespace OHOS {
    namespace Example {
    /**
     * @brief service服务，提供IPC调用接口
     * @ServiceClass
     */
        class test {
        public:
            int testFunc(int v1, int v2, bool v3);
        };
    }  // namespace Example
}  // namespace OHOS
#endif  // TEST_H
```

注意：.h文件中待生成的主class必须加注释：@brief service服务，提供IPC调用接口 ，如下所示：

```
/**
 * @brief service服务，提供IPC调用接口
 * @ServiceClass
 */
```

在window环境下的，根据输入.h文件生成的输出文件，如下所示：

![](./docs/figures/service_framework.png)

## FAQ

对于常见问题解决方法指导如下：

[FAQ](https://gitee.com/openharmony/napi_generator/tree/master/src/cli/h2sa/docs/guide/FAQ.md)

## 相关仓

暂无