Qt Creator 添加自定义新建文件/项目模板向导

Qt Creator 添加自定义新建文件/项目模板向导

翻译自：https://doc.qt.io/qtcreator/creator-project-wizards.html

如果你有一个正在构建构建大型应用程序或开发多个应用程序的团队，你可能希望标准化团队成员创建工程和文件的方式。

你可以复制模板文件夹中的新建向导模板来创建你自己的项目向导和文件向导。当你点击File > New File or Project时它们会在New对话框中显示。

在自定义的新建向导中，可以自定义一系列的向导页用户界面。用户在向导中填写的值被赋给字段名。字段名和值随后会在文件创建过程中被使用。

向导类型

在一个项目向导中，你可以指定一个项目所需要的文件。你可以添加向导页以允许开发者为项目指定设置。

文件向导与项目向导类似，但是不包含任何项目文件。

推荐你创建基于JSON的向导。它在功能上是以前所用的基于XML的向导的超集。更多内容请看：
译注：（Qt Creator 新建向导的步骤和详细文档主要在下面两篇文章中，我翻译了其中的基于JSON的）

• 添加基于JSON的向导
• 添加基于XML的向导 （已废弃）

查找向导模板位置

向导模板位于下面文件夹的子文件夹中：

• share/qtcreator/templates/wizards

• /opt/Qt5.13.0/Tools/QtCreator/share/qtcreator/templates/wizards

• 本地用户配置文件夹

  Linux 与 macOS 系统：$HOME/.config/QtProject/qtcreator/templates/wizards

  Windows系统： %APPDATA%\QtProject\qtcreator\templates\wizards

注意： 如果你用的是macOS，你可以在Qt Creator.app/Contents/Resources/templates/wizards中找到

向导开发的一些技巧

Qt Creator有一些可以改善向导开发过程的操作。它们默认没有与快捷键绑定，所以无法触发。为了启用它们，可以在进入快捷键设置：Tools > Options > Environment > Keyboard > Wizard

以下操作可以帮助向导开发：

操作	描述
Inspect	触发这个操作会打开一个窗口，列出触发操作时向导中所有已定义的字段和变量。例如，每次触发这个操作会打开一个新的非模态窗口，你可以对比不同向导页面的状态。
Factory.Reset	触发这个操作会让Qt Creator忘掉所有的向导工厂，使其在打开 File > New File or Project 时重新加载所有向导定义 。这样你可以在改变向导定义后，不用重启Qt Creator就能看到效果。

详细输出

当开发自定义向导时（包括基于JSON的和基于XML的向导），建议启动Qt Creator时加上-customwizard-verbose参数。这样每一个正在设置的向导都会产生下面的输出：
注意：

Checking "/home/jsmith/.config/QtProject/qtcreator/templates/wizards/mywizard"
for wizard.json.
* Configuration found and parsed.

输出信息中有wizard.json文件所在文件夹的名称。如果没有找到文件，这条消息将不会显示。

如果文件中有错误，例如无效的图标地址，以下信息会被显示：

Checking "/home/jsmith/.config/QtProject/qtcreator/templates/wizards/mywizard"
for wizard.json.
* Configuration found and parsed.
* Failed to create: Icon file
"/home/jsmith/.config/QtProject/qtcreator/templates/wizards/mywizard/../..
/global/genericfilewizard.png" not found.

查看使用命令行选项获取更多有关命令行参数的信息。

---

欢迎关注我的公众号：江达小记