Qt Creator添加可以快捷键注释的自定义片段(自动联想补全)

一、操作流程

  QtCreator=>工具=>选项=>片段=>添加/删除/编辑

二、具有在注释中自动添加时间或文件名等功能的

自动获取当前文件名称:%{CurrentDocument:FileName}
自动获取当前时间:%{CurrentDate:yyyy-MM-dd}  %{CurrentTime:hh:mm}
自动获取当前项目名称:%{CurrentProject:Name}
%{#:
%{Config:DefaultProjectDirectory}
%{Config:LastFileDialogDirectory}
%{Cpp:LicenseTemplate}
%{Cpp:LicenseTemplatePath:FileBaseName}
%{Cpp:LicenseTemplatePath:FileName}
%{Cpp:LicenseTemplatePath:FilePath}
%{Cpp:LicenseTemplatePath:NativeFilePath}
%{Cpp:LicenseTemplatePath:NativePath}
%{Cpp:LicenseTemplatePath:Path}
%{CurrentBuild:Env:}
%{CurrentBuild:Name}
%{CurrentBuild:Type}
%{CurrentDate:}
%{CurrentDate:ISO}
%{CurrentDate:Locale}
%{CurrentDate:RFC}
%{CurrentDevice:HostAddress}
%{CurrentDevice:PrivateKeyFile}
%{CurrentDevice:SshPort}
%{CurrentDevice:UserName}
%{CurrentDocument:Column}
%{CurrentDocument:ColumnCount}
%{CurrentDocument:FileBaseName}
%{CurrentDocument:FileName}
%{CurrentDocument:FilePath}
%{CurrentDocument:FontSize}
%{CurrentDocument:NativeFilePath}
%{CurrentDocument:NativePath}
%{CurrentDocument:Path}
%{CurrentDocument:Row}
%{CurrentDocument:RowCount}
%{CurrentDocument:Selection}
%{CurrentDocument:XPos}
%{CurrentDocument:YPos}
%{CurrentKit:FileSystemName}
%{CurrentKit:Id}
%{CurrentKit:Name}
%{CurrentProject:BuildPath}
%{CurrentProject:FileBaseName}
%{CurrentProject:FileName}
%{CurrentProject:FilePath}
%{CurrentProject:Name}
%{CurrentProject:NativeFilePath}
%{CurrentProject:NativePath}
%{CurrentProject:Path}
%{CurrentProject:QT_HOST_BINS}
%{CurrentProject:VcsName}
%{CurrentProject:VcsTopLevelPath}
%{CurrentProject:VcsTopic}
%{CurrentRun:Executable:FileBaseName}
%{CurrentRun:Executable:FileName}
%{CurrentRun:Executable:FilePath}
%{CurrentRun:Executable:NativeFilePath}
%{CurrentRun:Executable:NativePath}
%{CurrentRun:Executable:Path}
%{CurrentRun:Name}
%{CurrentTime:}
%{CurrentTime:ISO}
%{CurrentTime:Locale}
%{CurrentTime:RFC}
%{Env:}
%{HostOs:ExecutableSuffix}
%{HostOs:PathListSeparator}
%{HostOs:isLinux}
%{HostOs:isOSX}
%{HostOs:isUnix}
%{HostOs:isWindows}
%{IDE:ResourcePath}
%{JS:}
%{Session:FileBaseName}
%{Session:FileName}
%{Session:FilePath}
%{Session:Name}
%{Session:NativeFilePath}
%{Session:NativePath}
%{Session:Path}
%{UUID}

<think>我们正在使用Qt开发环境,并希望配置自定义的代码注释快捷方式。 根据引用[2]的内容,在Visual Studio中使用VAssistX插件可以方便地添加函数注释,但这是在VS环境中的方法。而我们现在是在Qt环境中(通常使用Qt Creator)。 引用[1]提到在Qt Creator中可以通过修改代码样式配置来自动生成函数注释,但并没有直接提到自定义快捷键。引用[3]则提到了自定义菜单栏和快捷方式栏,但这是应用程序级别的自定义,不是IDE的配置。 因此,我们需要在Qt Creator中设置自定义的代码注释快捷键。通常,代码注释有两种:行注释和块注释。在Qt Creator中,默认的注释快捷键是: - 行注释:Ctrl + / - 块注释:Ctrl + Shift + / 但是,用户可能希望自定义这些快捷键,或者添加其他类型的注释(如函数注释)的快捷键。 步骤: 1. 打开Qt Creator。 2. 进入“工具”->“选项”(在Windows和Linux下是Tools->Options,在macOS下是Qt Creator->Preferences)。 3. 在左侧选择“环境”,然后选择“键盘”。 4. 在键盘设置中,我们可以搜索现有的命令并修改它们的快捷键,也可以为没有默认快捷键的命令添加快捷键。 具体操作: - 在“键盘”设置界面的搜索框中输入“注释”,会过滤出与注释相关的命令。 - 通常有两个命令: TextEditor.ToggleCommentSelection (切换行注释) TextEditor.ToggleBlockComment (切换块注释) - 选择其中一个命令,然后在“快捷键”输入框中点击,按下你想要的组合键,然后点击“应用”即可。 注意:如果自定义快捷键与已有快捷键冲突,Qt Creator会提示。需要解决冲突(修改其他命令的快捷键或另选组合键)。 另外,如果我们希望像引用[2]中那样为函数自动生成注释(不仅仅是简单的注释,而是带有函数说明的模板),那么需要配置代码模板: 1. 在“选项”中,选择“C++”->“代码样式”。 2. 在右侧的选项卡中选择“编辑”当前使用的代码样式(或者复制一个进行修改)。 3. 在“注释”部分,可以设置函数注释的格式。但是,这里并没有直接设置快捷键。 4. 要自动生成函数注释,通常是在函数定义的上方输入`/**`然后按回车,就会根据函数参数生成文档注释(类似于Doxygen风格)。这个功能默认是开启的,但也可以在这里配置模板。 但是,用户要求的是自定义快捷键。对于生成函数注释Qt Creator默认没有提供快捷键,我们可以通过以下步骤设置: - 在“键盘”设置中,搜索命令“InsertTemplate”,这个命令可以插入模板。但是,默认情况下,函数注释的插入是通过特定触发字符(如`/**`)实现的,而不是快捷键。 - 我们可以为“InsertTemplate”命令设置一个快捷键,但这样会打开模板选择对话框,而不是直接插入函数注释。 因此,更直接的方法可能是使用代码片段(Snippets)功能: 1. 在“选项”中,选择“文本编辑器”->“片段”。 2. 我们可以创建一个新的片段,比如命名为“funcComment”,触发字符可以设置为`fcom`(或者自定义),然后在片段内容中编写注释模板,例如: /** * @brief * @param * @return */ 3. 这样,在代码中输入`fcom`然后按Tab键,就会展开为上面的模板。 但是,这仍然不是快捷键。我们可以将触发字符设置得很短,但无法直接绑定到快捷键。 另一种思路:使用宏(Qt Creator支持宏的录制和自定义,但功能有限)或插件。 然而,对于大多数用户来说,使用默认的注释快捷键(Ctrl+/)和文档注释触发方式(输入`/**`然后回车)已经足够。 总结: 1. 修改注释快捷键:在“环境”->“键盘”中设置。 2. 自动生成函数注释:在函数上方输入`/**`然后按回车(不需要快捷键)。 3. 自定义函数注释模板:在“C++”->“代码样式”->“编辑”->“注释”中设置。 因此,回答用户问题:如何在Qt中配置自定义代码注释的快捷方式? 答:可以通过Qt Creator的键盘设置来修改注释快捷键。具体步骤如下: - 打开Qt Creator。 - 进入“工具”->“选项”。 - 选择“环境”,然后选择“键盘”。 - 在搜索框中输入“注释”,找到“TextEditor.ToggleCommentSelection”(行注释)和“TextEditor.ToggleBlockComment”(块注释)命令。 - 选中命令,在“快捷键”输入框中设置自定义的组合键,点击“应用”即可。 另外,对于函数注释,默认没有快捷键,但可以通过输入`/**`并回车来自动生成。如果想通过快捷键触发,可以考虑使用代码片段(Snippets)功能,但需要输入触发词并按Tab键,而不是直接快捷键。 如果用户希望有直接生成函数注释快捷键,目前Qt Creator原生不支持,可能需要编写插件来实现。但考虑到复杂性和一般需求,建议使用默认的文档注释方式。 相关问题: §§相关问题§§ 1. 如何在Qt Creator中配置代码片段(Snippets)? 2. Qt Creator中如何录制和使用宏? 3. 如何为Qt Creator开发自定义插件?</think>在 Qt Creator 中配置自定义代码注释快捷方式,可通过以下步骤实现: ### 配置步骤 1. **打开键盘设置** 进入 `工具` → `选项` → `环境` → `键盘`(Windows/Linux) 或 `Qt Creator` → `偏好设置` → `环境` → `键盘`(macOS) 2. **搜索注释命令** 在搜索框输入以下命令标识符: - 行注释:`TextEditor.ToggleCommentSelection` - 块注释:`TextEditor.ToggleBlockComment` 3. **自定义快捷键** - 选中目标命令(如行注释) - 点击 `快捷键` 输入框 - 按下自定义组合键(如 `Ctrl+Shift+C`) - 点击 `应用` 保存设置 ![图示:快捷键设置界面](https://doc.qt.io/qtcreator/images/qtcreator-options-keyboard.png) *图:Qt Creator 键盘设置界面[^1]* 4. **解决快捷键冲突** 若提示冲突,需先清除被占用命令的快捷键,再重新分配。 ### 扩展配置 - **自动生成函数注释**: 在 `C++` → `代码样式` 中配置注释模板,输入 `/**` + `回车` 自动生成文档注释[^1]。 - **代码片段快捷插入**: 在 `文本编辑器` → `片段` 中创建自定义片段(如函数头注释),通过预设触发词快速插入。 ### 注意事项 1. 部分命令需重启 Qt Creator 生效 2. 不同语言C++/Python/QML)共享同一快捷键配置 3. 推荐保留默认 `Ctrl+/` 作为行注释,避免与其他操作冲突 > 示例:将块注释设为 `Ctrl+Shift+/` 后,选中代码按下该组合键: > ```cpp > // 注释前 > void test(){ qDebug() << "Hello"; } > > /* 注释后 > void test(){ qDebug() << "Hello"; } > */ > ```
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值