From f854fb3599e30d22373381cfe8a366b269f7f83a Mon Sep 17 00:00:00 2001 From: Levi Yan Date: Thu, 26 Sep 2024 12:26:17 +0800 Subject: [PATCH] add developer manual doc --- docs/developer_manual.md | 44 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/developer_manual.md diff --git a/docs/developer_manual.md b/docs/developer_manual.md new file mode 100644 index 0000000..cf9afd2 --- /dev/null +++ b/docs/developer_manual.md @@ -0,0 +1,44 @@ +## 项目结构 + +`package.json` + +- 插件基本信息 +- 插件的命令、对外开放的接口 +- 插件的activity bar、status bar +- scripts +- 项目配置、依赖 + +`tsconfig.json`、`webpack.config.js` + +- ts编译为js的配置 + +assets目录 + +- 静态资源 + +源文件 + +- `main.ts`:负责构建插件、构建插件过程的操作,activate/deactivate插件 +- `home.ts`:负责与home页面相关的操作,如构建home页面(webview)、作为home页面与vscode交互的桥梁 + - home页面 - embedded.html +- views目录:负责vscode中除home页面的其他界面设计 + - `quick-access-tree.ts`负责左侧快速访问栏 +- `remote-container.ts`:负责与remote container相关的操作,如第一次连接容器、打开容器中的项目文件夹 +- `utils.ts`:一些通用函数 + + + +.devcontainer目录 + +- devcontainer相关配置 + +.vscode目录 + +- `launch.json`:(编译)启动插件配置 + + +## 模块 + +Remote container + +Home \ No newline at end of file