Qt设置自动注释

1.方法如下

工具–>选项：

添加关键字以及文本（可以将触发种类设置为custom）：

2.附内部变量

%{#:<value>
%{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:<value>}
%{CurrentBuild:Name}
%{CurrentBuild:Type}
%{CurrentDate:<value>}
%{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:<value>}
%{CurrentTime:ISO}
%{CurrentTime:Locale}
%{CurrentTime:RFC}
%{Env:<value>}
%{HostOs:ExecutableSuffix}
%{HostOs:PathListSeparator}
%{HostOs:isLinux}
%{HostOs:isOSX}
%{HostOs:isUnix}
%{HostOs:isWindows}
%{IDE:ResourcePath}
%{JS:<value>}
%{Session:FileBaseName}
%{Session:FileName}
%{Session:FilePath}
%{Session:Name}
%{Session:NativeFilePath}
%{Session:NativePath}
%{Session:Path}
%{UUID}

3.函数注释示例

/***************************************************************
* @function name: 
* @摘要            
* @输入参数
* @输出参数          无
* @返回值            void
* @author           xmr
* @date             %{CurrentDate:yyyy-MM-dd} 
**************************************************************/

4.文件注释示例

/******************************************************************************

  Copyright (C), 2017-2027, fensnote@163.com, Ltd.

 ******************************************************************************
  File Name     : %{CurrentDocument:FileName} 
  Version       : 1.0
  Author        : xmr
  Created       : %{CurrentDate:yyyy-MM-dd} 
  Last Modified :
  Description   :  header file
  Function List :
  History       :
  1.Date        : %{CurrentDate:yyyy-MM-dd} 
    Author      : xmr
    Modification: Created file

******************************************************************************/

5.其他常用注释的使用

QT中除了文件头注释不能自动生成，其他的注释都可以自动生成。所以接下来将直接使用了，下面的操作，属于qt自带。

（1）头文件中

a.类头注释模板

/**
 * @brief 类的简单概述
 * 类的详细概述
 */

b.成员变量注释模板

///< 成员变量简要说明，单行注释
或者
/**
 * @brief m_Imagetimer
 * 成员变量简要说明，多行注释
 */

（2）源文件中

函数头注释模板：

/*
 * @brief   函数功能说明
 *
 * 解释复杂代码块的流程
 *
 * @param a 参数a说明
 * @param b 参数b说明
 *
 * @return 返回值描述
 */