生成首个 Project 任务窗格加载项

2025-09-22

本文将逐步介绍如何生成 Project 任务窗格加载项。

先决条件

Node.js（最新LTS 版本）。访问 Node.js 站点，下载并安装适合你的作系统的版本。
最新版本的 Yeoman 和适用于 Office 加载项的 Yeoman 生成器。若要全局安装这些工具，请从命令提示符处运行以下命令。
```
npm install -g yo generator-office
```
注意

即便先前已安装了 Yeoman 生成器，我们还是建议你通过 npm 将包更新为最新版本。
已连接到 Microsoft 365 订阅的 Office (包括 Office 网页版)。

注意

如果还没有 Office，可以通过 Microsoft 365 开发人员计划获得Microsoft 365 E5开发人员订阅;有关详细信息，请参阅常见问题解答。或者，可以注册 1 个月的免费试用版或购买 Microsoft 365 计划。

Windows 版 Project 2016 或更高版本

创建加载项

运行以下命令，使用 Yeoman 生成器创建加载项项目。包含项目的文件夹将添加到当前目录。

yo office

注意

运行该yo office命令时，可能会收到有关 Yeoman 和 Office 加载项 CLI 工具的数据收集策略的提示。根据你的需要，使用提供的信息来响应提示。

出现提示时，请提供以下信息以创建加载项项目。

选择项目类型：Office Add-in Task Pane project
选择脚本类型：JavaScript
要为外接程序命名什么名称？My Office Add-in
你希望支持哪个 Office 客户端应用程序？Project

命令行界面中 Yeoman 生成器的提示和回答。

完成此向导后，生成器会创建项目，并安装支持的 Node 组件。

浏览项目

使用 Yeoman 生成器创建的加载项项目，包含适合于基础任务窗格加载项的示例代码。

项目根目录中的 ./manifest.xml 文件定义加载项的设置和功能。
./src/taskpane/taskpane.html 文件包含组成任务窗格的 HTML。
./src/taskpane/taskpane.css 文件包含应用于任务窗格中的内容的 CSS。
./src/taskpane/taskpane.js 文件包含用于加快任务窗格与 Office 客户端应用程序之间的交互的 Office JavaScript API 代码。在本快速入门中，代码设置了项目所选任务的 Name 字段和 Notes 字段。

试用

导航到项目的根文件夹。
```
cd "My Office Add-in"
```
完成以下步骤，以启动本地 Web 服务器并旁加载你的加载项。
注意
- 即使在开发过程中，Office 外接程序也应使用 HTTPS，而不是 HTTP。如果在运行以下命令之一后系统提示安装证书，请接受安装 Yeoman 生成器提供的证书的提示。你可能还必须以管理员身份运行命令提示符或终端才能进行更改。
- 如果这是你第一次在计算机上开发 Office 加载项，则命令行中可能会提示你授予Microsoft Edge WebView 环回豁免 (“允许 Microsoft Edge WebView 的 localhost 环回？”) 。出现提示时，输入 Y 以允许豁免。请注意，需要管理员权限才能允许豁免。一旦允许，在将来 (旁加载 Office 加载项时，系统就不会提示你获得豁免，除非从计算机) 中删除该豁免。若要了解详细信息，请参阅加载 Office 外接程序或使用 Fiddler 时，“我们无法从 localhost 打开此外接程序”。
- 首次使用 Yeoman 生成器开发 Office 加载项时，默认浏览器会打开一个窗口，提示你登录到 Microsoft 365 帐户。如果未显示登录窗口，并且遇到旁加载或登录超时错误，请运行 atk auth login m365。
- 若要在 Project 中测试加载项，请在项目的根目录中运行以下命令。这会启动本地 Web 服务器并旁加载加载项。
```
npm start
```
如果加载项未自动旁加载，请按照在 Windows 上旁加载 Office 加载项中的说明在 Project 中手动旁加载加载项。
在 Project 中，创建一个简单的项目计划。
在项目中选择单个任务。
在任务窗格的底部，选择“运行”链接以重命名所选任务并向所选任务添加备注。
如果要停止本地 Web 服务器并卸载加载项，请按照适用的说明作：
- 若要停止服务器，请运行以下命令。如果使用 npm start，则以下命令也会卸载加载项。
```
npm stop
```
- 如果手动旁加载加载项，请参阅删除旁加载加载项。

疑难解答

按照设置开发环境中的说明，确保环境已准备好进行 Office 开发。
一些示例代码使用 ES6 JavaScript。这与使用 Trident (Internet Explorer 11) 浏览器引擎的旧版 Office 不兼容。有关如何在外接程序中支持这些平台的信息，请参阅支持较旧的Microsoft Webviews 和 Office 版本。如果还没有用于开发的 Microsoft 365 订阅，可以通过 Microsoft 365 开发人员计划获得Microsoft 365 E5开发人员订阅;有关详细信息，请参阅常见问题解答。或者，可以注册 1 个月的免费试用版或购买 Microsoft 365 计划。

Yo Office 执行的自动 npm install 步骤可能会失败。如果在尝试运行 npm start时看到错误，请在命令提示符中导航到新创建的项目文件夹并手动运行 npm install。有关 Yo Office 的详细信息，请参阅使用 Yeoman 生成器创建 Office 外接程序项目。
运行 Yeoman 生成器或项目时 npm install ，可能会看到生成警告。在大多数情况下，可以放心地忽略这些警告。有时，依赖项将弃用，并且项目所依赖的其他包不支持其替换项。若要解决这些警告，请使用 npm-check-updates 工具。
- 在根项目目录中的命令提示符下，运行 npm i -g npm-check-updates。这会全局安装该工具。
- 运行 ncu -u。这会提供所有包及其将更新的版本的报告。
- 运行 npm install 以更新所有包。
有关运行 npm install时的警告的详细信息，请参阅 Node.js 和 npm 世界中的警告和依赖项。

后续步骤

恭喜！已成功创建 Project 任务窗格加载项！接下来，请详细了解 Project 加载项功能，并探索常见方案。

Project 加载项

另请参阅

反馈

此页面是否有帮助？