AutoHotkey辅助生成DoxyGen风格的注释

2024-03-25 15:38

本文主要是介绍AutoHotkey辅助生成DoxyGen风格的注释,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

    遵守DoxyGen 注释规范,可以使代码注释更加完善的同时,还能自动生成帮助文档。但在初次接触它时,隐约之中对它会有些担心,总担心要去记忆注释的格式,担心要用的时候老忘记格式,从而要经常去翻阅它的帮助文档,这无形中增加了工作量。

 

    为了消除这种恐惧,我决定用 AutoHotkey 写一个辅助生成 DoxyGen 注释的脚本,一来方便生成注释更加漂亮,二来自动生成的注释符合 DoxyGen 风格,从而不必再去记忆!端午有 5 天假,刚好用来实现这些想法。

 

目前实现的功能有 3 个,

1 、辅助生成文件注释

2 、辅助生成函数注释

3 、在选定的行末尾添加行注释

 

  

1 、辅助生成文件注释

在任意位置输入 //file 回车命令,将弹出对话框如下:

 

填写好内容之后,按插入按钮,将生成文件注释并替换 //file 命令。效果如下

/**

*@file         test.h

*@author        teshorse

*@date         2010.06.17

*@brief          简要说明

*

* 详细说明

*- 说明 1

*- 说明 2

*/

 

2 、辅助生成函数注释

使用方法:首先选中函数的声明部分,同时按下 Appskey + / 键,弹出类似 CS 游戏的菜单,

然后按 2 选择“为选中的函数生成 DoxyGen 风格的注释”,如下图所示:

 

选择选项 2 以后,弹出对话框:

按图填写内容之后,按生成注释按钮,生成如下注释:

/** @brief         函数简要说明

  * @param[out]strCode  参数 1

  * @param[in]        iFlag  参数 2

  * @return         返回值

  * @return         返回值说明 1

  * @return         说明 2

  */

AnsiString Tfrm_d01_rctzzlwjsc::GetLTGBS(AnsiString strCode,int iFlag)

注意:

1 )参数 1 后的复选框选中之后,意味着参数 1 [Out] 的,否则为 [In]

2 )参数列中的函数及参数名称,从选中的函数声明中自动获取

3 )参数的个数及名称可以手动修改

4 )说明那一列,即是需要填写的注释部分

 

3 、在选定的行末尾添加行注释

这个功能的目的,是在选中多行代码,在每一行末尾整齐地添加行尾注释符号,适用用给枚举或者结构体统一添加行末注释符号。具体操作如下:

1 )选中要添加行尾注释的行

2 )按下 Appskey+/  弹出 CS 菜单,效果如下

3 )选中选项 1 ,“为选中的行添加 DoxyGen 风格的行尾注释”,弹出下面的对话框

>> 按钮可以增加缩进,按钮 << >> 之间的值是实际缩进量,如

可修改行末的注释符号为 ///<

调整完毕之后,按确定键复制到剪贴板,生成的效果如下:

 

 

怎么样,这样生成行尾注释即方便又漂亮吧!

完毕!

 

4 、再介绍一个生成带有线条的行注释,不过这个不是 Doxy Gen 风格了:

因为我个人喜欢用带线条的注释,如下:

//--- 测试函数 ----------------------------------------------------------------

这种注释,如果能保证线条加注释长度一致,将很整齐漂亮,但手工去调整线条长是令人纠结的事情。为此写了下面的如下的脚本代码,实现自动调整线条长度。介绍如下:

 

首先在任意文本编辑处输入 //w 回车,将窗口如下窗口:


上面的“注释内容”编辑框是你想要写的注释,中间列表框选择注释风格,下面预览框可预览效果。

右边可调节注释符号、组成线型的字符、注释长度等。当你修改任意编辑框时,都会实时生成预览效果。“确定”之后,将预览中的内容粘贴到输入 //w 的位置。

 

这篇关于AutoHotkey辅助生成DoxyGen风格的注释的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/845461

相关文章

Python中注释使用方法举例详解

《Python中注释使用方法举例详解》在Python编程语言中注释是必不可少的一部分,它有助于提高代码的可读性和维护性,:本文主要介绍Python中注释使用方法的相关资料,需要的朋友可以参考下... 目录一、前言二、什么是注释?示例:三、单行注释语法:以 China编程# 开头,后面的内容为注释内容示例:示例:四

python编写朋克风格的天气查询程序

《python编写朋克风格的天气查询程序》这篇文章主要为大家详细介绍了一个基于Python的桌面应用程序,使用了tkinter库来创建图形用户界面并通过requests库调用Open-MeteoAPI... 目录工具介绍工具使用说明python脚本内容如何运行脚本工具介绍这个天气查询工具是一个基于 Pyt

Python实现自动化Word文档样式复制与内容生成

《Python实现自动化Word文档样式复制与内容生成》在办公自动化领域,高效处理Word文档的样式和内容复制是一个常见需求,本文将展示如何利用Python的python-docx库实现... 目录一、为什么需要自动化 Word 文档处理二、核心功能实现:样式与表格的深度复制1. 表格复制(含样式与内容)2

python如何生成指定文件大小

《python如何生成指定文件大小》:本文主要介绍python如何生成指定文件大小的实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录python生成指定文件大小方法一(速度最快)方法二(中等速度)方法三(生成可读文本文件–较慢)方法四(使用内存映射高效生成

Maven项目中集成数据库文档生成工具的操作步骤

《Maven项目中集成数据库文档生成工具的操作步骤》在Maven项目中,可以通过集成数据库文档生成工具来自动生成数据库文档,本文为大家整理了使用screw-maven-plugin(推荐)的完... 目录1. 添加插件配置到 pom.XML2. 配置数据库信息3. 执行生成命令4. 高级配置选项5. 注意事

MybatisX快速生成增删改查的方法示例

《MybatisX快速生成增删改查的方法示例》MybatisX是基于IDEA的MyBatis/MyBatis-Plus开发插件,本文主要介绍了MybatisX快速生成增删改查的方法示例,文中通过示例代... 目录1 安装2 基本功能2.1 XML跳转2.2 代码生成2.2.1 生成.xml中的sql语句头2

CSS 样式表的四种应用方式及css注释的应用小结

《CSS样式表的四种应用方式及css注释的应用小结》:本文主要介绍了CSS样式表的四种应用方式及css注释的应用小结,本文通过实例代码给大家介绍的非常详细,详细内容请阅读本文,希望能对你有所帮助... 一、外部 css(推荐方式)定义:将 CSS 代码保存为独立的 .css 文件,通过 <link> 标签

使用Python自动化生成PPT并结合LLM生成内容的代码解析

《使用Python自动化生成PPT并结合LLM生成内容的代码解析》PowerPoint是常用的文档工具,但手动设计和排版耗时耗力,本文将展示如何通过Python自动化提取PPT样式并生成新PPT,同时... 目录核心代码解析1. 提取 PPT 样式到 jsON关键步骤:代码片段:2. 应用 JSON 样式到

SpringBoot实现二维码生成的详细步骤与完整代码

《SpringBoot实现二维码生成的详细步骤与完整代码》如今,二维码的应用场景非常广泛,从支付到信息分享,二维码都扮演着重要角色,SpringBoot是一个非常流行的Java基于Spring框架的微... 目录一、环境搭建二、创建 Spring Boot 项目三、引入二维码生成依赖四、编写二维码生成代码五

Android与iOS设备MAC地址生成原理及Java实现详解

《Android与iOS设备MAC地址生成原理及Java实现详解》在无线网络通信中,MAC(MediaAccessControl)地址是设备的唯一网络标识符,本文主要介绍了Android与iOS设备M... 目录引言1. MAC地址基础1.1 MAC地址的组成1.2 MAC地址的分类2. android与I