autohotkey辅助生成doxygen风格的注释-尊龙官方平台

autohotkey辅助生成doxygen风格的注释

el/2024/3/25 15:36:38

    遵守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 的位置。

 


http://www.ngui.cc/el/5126757.html

相关文章

用 autohotkey分析日志文件得到耗时最大的记录

用 autohotkey分析日志文件得到耗时最大的记录 现在有上百个日志文件如 log20100621.txt,每个文件几万条记录,记录示例: [开始发布时间:2010-06-21 09:04:25][发布最终页1个,耗费1: 2秒][刷新列表页1个,耗费2: 3秒][总共耗费:6秒] 现在…

向程序员推荐autohotkey

已经使用autohotkey两三年了,它是 windows操作系统下的脚本工具,程序员使用它,可以大大优化操作、辅助编写代码、帮助分析文件、节省大量时间。而对于程序员而言,写 autohotkey脚本是轻而易举的事情,因此在这里向程序员…

“飞扬小字典” -- 辅助记忆的小工具

关于飞扬小字典 v2.13  飞扬小字典,致力于打造一个辅助记忆的小工具,  要求能够极速地记录和搜索零碎的文本片段,追求速度!    其特点如下:  1、一个快捷键瞬间启动,esc立刻退出(快到不会…

onenote 笔记本世界的航空母舰

你会不会在寻找一种电子工具,它能够像在白纸上一样自由地写字、作画,这样可以用它来记录自己思绪、灵感、心声? 我曾经尝试过很多笔记软件,然而都不是我心目中的那个她。他们都像 word 一样,有宽度限制,而…

窗口快捷控制器-—让大尺寸屏幕更爽

最近换了22寸的液晶显示器,很爽,写代码时,可以同时打开多个编辑器并且同时排列在桌面, 再也不用切来换去了。然而,任何事情都有两面性,由于屏幕太大,很多窗口最大化时将十分恐怖, 由…

vc内存泄露检查方法

介绍:   动态分配、回收内存是c/c编程语言一个最强的特点,但是中国哲学家孙(sun tzu,我不知道是谁?那位知道?) 指出,最强的同时也是最弱的。这句话对c/c应用来说非常正确…

飞扬热键发布

飞扬热键,是一种优化用户操作习惯、提高工作效率的工具集合。它通过将画屏命令、快捷热键、快捷菜单以及命令窗口融为一体,达到快速启动程序、打开文档、自定义短语、模拟用户输入输出的目的。 这些命令、热键与快捷菜单都可以自由定义和组合,…

windows vim配置文件:解决utf8乱码

gvim打开utf-8格式的文件时,中文将显示为乱码  解决办法:在_vimrc配置文件中添加以下内容即可: if has(”multi_byte”) set fileencodingsucs-bom,utf-8,cp936,big5,euc-jp,euc-kr,latin1 if v:lang ~ “^zh_cn” set encodingcp936 set t…

vim编码方面的基础知识

vim中编辑不同编码的文件时需要注意的一些地方 此文讲解的是vim编辑多字节编码文档(中文)所要了解的一些基础知识,注意其没有涉及gvim,纯指字符终端下的vim。 vim编码方面的基础知识: 1,存在3个变量&#x…

vc2008中unicode字符集下writefile中文处理

最近在使用writefile函数时发现,vc2008中unicode字符集下处理中文乱码的一些解决方法,归纳如下 1. 写入的时候采用多字节char类型 handle hfile;dword nbytes;hfilecreatefile(_t("test.txt"),generic_write,file_share_write,null,create_always,0,null)…
网站地图