source insight一键添加注释

最新推荐文章于 2025-02-20 23:04:33 发布
最新推荐文章于 2025-02-20 23:04:33 发布
阅读量1.4k 收藏 10
点赞数 8
分类专栏： si 文章标签： 经验分享 编辑器 团队开发 代码规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_42529949/article/details/142794243
版权

本文列举说明了在source insight中如何快捷地给我们的代码添加注释，包括文件头注释、函数定义注释、函数声明注释。

  • 首先在source insight安装目录下的C:\Source Insight 4.0\Projects\Base文件夹新建一个custom.em文件，用来编写我们自定义的函数。
    在这里插入图片描述

  • 然后将custom.em文件添加到工程目录中
    1.点击Project->Add and Remove Project Files…
    在这里插入图片描述
    2.在“File Name:”中将文件的路径粘贴然后回车，这样就进入到了Base文件夹，选中custom.em文件后点击Add，然后关闭窗口，至此就将custom.em文件添加到了我们的工程中了在这里插入图片描述

  • 接着就是开始编写函数代码
    1. 添加文件头注释

/*获取文件名称*/
macro GetFileName(pathName)
{
	nlength = strlen(pathName)
	i = nlength - 1
	name = ""
	while (i + 1)
	{
		ch = pathName[i]
		if ("\\" == "@ch@")
			break
		i = i - 1
	}
	i = i + 1
	while (i < nlength)
	{
		name = cat(name, pathName[i])
		i = i + 1
	}

	return name
}


macro CustomInsertFileHeader()
{
 	//get crrunt time
 	szTime = GetSysTime(1)
 	
    Day = ""
	len = strlen(szTime.Day)	
	if("@len@" == "1")
	{
		Day = cat(Day, 0)
	}
	Day = cat(Day, szTime.Day)
	
	Month = ""
	len = strlen(szTime.Month)
	if("@len@" == "1")
	{
		Month = cat(Month, 0)
	}
	Month = cat(Month, szTime.Month)

 	Year = szTime.Year
 	hbuf = GetCurrentBuf()//申请变量空间，Get a handle to the current file buffer and the name
 	PathName = GetBufName(hBuf)
 	FileName = GetFileName(PathName)
	FileNameLen = strlen(FileName)


 	hbuf = GetCurrentBuf()
	InsBufLine(hbuf, 0, "/********************************************************************************")
	InsBufLine(hbuf, 1, "  * Copyright (C), XXX Tech. Co., Ltd.")
 	InsBufLine(hbuf, 2, "********************************************************************************")
	InsBufLine(hbuf, 3, "  * DESCRIPTION")
	InsBufLine(hbuf, 4, "  * ")
 	InsBufLine(hbuf, 5, "********************************************************************************")
 	InsBufLine(hbuf, 6, "  * \@file        @FileName@")
 	InsBufLine(hbuf, 7, "  * \@version     v1.0.0")
 	InsBufLine(hbuf, 8, "  * \@author      wqc")
 	InsBufLine(hbuf, 9, "  * \@date        @Year@/@Month@/@Day@")
	InsBufLine(hbuf, 10, "********************************************************************************")
 	InsBufLine(hbuf, 11, "  * Modification History")
 	InsBufLine(hbuf, 12, "  * @Year@-@Month@-@Day@  WQC Created")
 	InsBufLine(hbuf, 13,"********************************************************************************/")
	InsBufLine(hbuf, 14,"")
	InsBufLine(hbuf, 15,"/********************************************************************************")
	InsBufLine(hbuf, 16,"//include")
	InsBufLine(hbuf, 17,"********************************************************************************/")

	FileName[FileNameLen-1] = h;
	InsBufLine(hbuf, 18,"#include \"@FileName@\"")
	InsBufLine(hbuf, 19,"")
	InsBufLine(hbuf, 20,"")
	InsBufLine(hbuf, 21,"")
}

效果图
在这里插入图片描述

2. 添加函数定义注释

macro CustomInsertFuncHeader()
{
    /* 获取光标所在行 */
    handle = GetCurrentWnd()
    process_line = GetWndSelLnFirst(handle)
		
    /* 获取函数所在行文本 */
    file_txt = GetCurrentBuf()
    process_txt = GetBufLine(file_txt,process_line + 1)
    process_txt_len = strlen(process_txt)

    if(process_txt == "")
    {
        stop
    }

    /* 获取函数名 */
    symbol_rec = GetSymbolLocationFromLn (handle, process_line + 1)
    if(symbol_rec == "")
    {
        stop
    }

    fuction_name = symbol_rec.Symbol

    /* 获取参数个数及参数名           */
    param_num = 0
    param_list = SymListNew()

    i=0,j=0
    while(i < process_txt_len)
    {
        if(process_txt[i] == "," || process_txt[i] == ")")
        {
            j = i
            while(j > 0)
            {
                if(process_txt[j] == " " || process_txt[j] == "*" || process_txt[j] == "&" ||
                   process_txt[j] == "(")
                {
                    symbol_rec.Symbol = strmid(process_txt,j+1,i)
                    SymListInsert(param_list,param_num,symbol_rec)
                    param_num = param_num + 1
                    break;
                }
                j = j - 1
            }
        }

        i = i + 1
    }

    /* 输出注释 */
    PutBufLine(handle,process_line + 0,"")
    InsBufLine(handle,process_line + 1,"/*******************************************************************************")

    var temp_buffer
    temp_buffer = cat("  * \@FunctionName: ",fuction_name)
    InsBufLine(handle,process_line + 2,temp_buffer)

    InsBufLine(handle,process_line + 3,"  * \@Author:       wqc")
    InsBufLine(handle,process_line + 4,"  * \@Description:  ")
    
    sys_time = GetSysTime(1)
    temp_buffer = "  * \@Date:\t\t   "
    temp_buffer = cat(temp_buffer,sys_time.Year)
    temp_buffer = cat(temp_buffer,"/")
    
    /* 月份和日期转为2位占位符 */
    len = strlen(sys_time.Month)
    if("@len@" == 1)
    {
	   temp_buffer = cat(temp_buffer,0)
    }
 	temp_buffer = cat(temp_buffer,sys_time.Month)
    temp_buffer = cat(temp_buffer,"/")
    
    len = strlen(sys_time.Day)
    if("@len@" == 1)
    {
	   temp_buffer = cat(temp_buffer,0)
    }
    temp_buffer = cat(temp_buffer,sys_time.Day)

    InsBufLine(handle,process_line + 5,temp_buffer)
    
    param_line = process_line + 6
    InsBufLine(handle,param_line,"*******************************************************************************/")


	temp_buffer = "  * \@ReturnVal:    "
    if(strmid(process_txt,0,6) == "static")
    {
	    if(strmid(process_txt,7,11) != "void")
	    {
			/* 定位返回值类型的位置并输出 */
			i = 7
			j = strlen(fuction_name)
	        while(i < process_txt_len)
	        {
				if(strmid(process_txt,i,i + j) == "@fuction_name@")
				{
					i = i - 1
					j = 7
					while(j < i)
					{
					  temp_buffer = cat(temp_buffer,process_txt[j])
					  j = j + 1
					}
					break
				}
				i = i + 1
	        }

			temp_buffer = cat(temp_buffer,"    [description]")

	        InsBufLine(handle,param_line,"  * !-->Value1     [description]")
	        InsBufLine(handle,param_line,"  * !-->Value2     [description]")
	    }
	    else
	    {
			temp_buffer = cat(temp_buffer,None)
	    }
	  }
	  else if(strmid(process_txt,0,4) != "void")
	  {
			/* 定位返回值类型的位置并输出 */
			i = 0
			j = strlen(fuction_name)
	        while(i < process_txt_len)
	        {
				if(strmid(process_txt,i,i + j) == "@fuction_name@")
				{
					i = i - 1
					j = 0
					while(j < i)
					{
					  temp_buffer = cat(temp_buffer,process_txt[j])
					  j = j + 1
					}
					break
				}
				i = i + 1
	        }
		  temp_buffer = cat(temp_buffer,"    [description]")

	        InsBufLine(handle,param_line,"  * !-->Value1     [description]")
	        InsBufLine(handle,param_line,"  * !-->Value2     [description]")
	  }
	  else
	  {
			temp_buffer = cat(temp_buffer,None)
	  }
	  InsBufLine(handle,param_line, temp_buffer)
	  
    while(param_num > 0)
    {
        param_num = param_num - 1
        symbol_rec = SymListItem(param_list,param_num)

        temp_buffer = "  * \@Param:        "
        
        if(symbol_rec.Symbol == "void")
        {
	        temp_buffer = cat(temp_buffer,None)
        }
        else
        {
	        temp_buffer = cat(temp_buffer,symbol_rec.Symbol)
	        temp_buffer = cat(temp_buffer,"             [description]")
        }

        temp_buffer_len = strlen(temp_buffer)
        temp_buffer_len = 38 - temp_buffer_len
        while(temp_buffer_len > 0)
        {
            temp_buffer_len = temp_buffer_len - 1
            temp_buffer = cat(temp_buffer," ")
        }

        InsBufLine(handle,param_line,temp_buffer)
    }

    SymListFree(param_list)
}

效果图
函数有形参有返回值
在这里插入图片描述
函数有形参无返回值
在这里插入图片描述
函数无形参有返回值在这里插入图片描述
函数无形参无返回值在这里插入图片描述
3. 添加函数声明注释

macro CustomInsertFuncHeaderDeclaration()
{
    var temp_buffer

    /* 获取光标所在行 */
    handle = GetCurrentWnd()
    process_line = GetWndSelLnFirst(handle)

    /* 获取函数所在行文本 */
    file_txt = GetCurrentBuf()
    process_txt = GetBufLine(file_txt,process_line + 1)
    process_txt_len = strlen(process_txt)

    if(process_txt == "")
    {
        stop
    }

    /* 获取函数名 */
    symbol_rec = GetSymbolLocationFromLn (handle, process_line + 1)
    if(symbol_rec == "")
    {
        stop
    }

    fuction_name = symbol_rec.Symbol

    /* 获取参数个数及参数名           */
    param_num = 0
    param_list = SymListNew()

    i=0,j=0
    while(i < process_txt_len)
    {
        if(process_txt[i] == "," || process_txt[i] == ")")
        {
            j = i
            while(j > 0)
            {
                if(process_txt[j] == " " || process_txt[j] == "*" || process_txt[j] == "&" ||
                   process_txt[j] == "(")
                {
                    symbol_rec.Symbol = strmid(process_txt,j+1,i)
                    SymListInsert(param_list,param_num,symbol_rec)
                    param_num = param_num + 1
                    break;
                }
                j = j - 1
            }
        }

        i = i + 1
    }

    /* 输出注释 */
    PutBufLine(handle,process_line++,"")
    InsBufLine(handle,process_line++,"/***")
    InsBufLine(handle,process_line++," * \@Brief  description")
    InsBufLine(handle,process_line++," * \@Param")
    
    while(param_num > 0)
    {
        param_num = param_num - 1
        symbol_rec = SymListItem(param_list,param_num)

        if(symbol_rec.Symbol == "void")
        {
		    PutBufLine(handle,process_line - 1," * \@Param     None")
		    break
        }
        else
        {
	        temp_buffer = " * !-->"
	        temp_buffer = cat(temp_buffer,symbol_rec.Symbol)
	        temp_buffer = cat(temp_buffer,"    [description]")
        }

        temp_buffer_len = strlen(temp_buffer)
        temp_buffer_len = 38 - temp_buffer_len
        while(temp_buffer_len > 0)
        {
            temp_buffer_len = temp_buffer_len - 1
            temp_buffer = cat(temp_buffer," ")
        }

        InsBufLine(handle,process_line++,temp_buffer)
    }
    SymListFree(param_list)

    if(strmid(process_txt,0,4) != "void")
    {
    	temp_buffer = " * \@ReturnVal "
    	i = 0
        while(i < process_txt_len)
        {
        	if(process_txt[i] != " ")
        	{
		       temp_buffer = cat(temp_buffer, process_txt[i++])
        	}
        	else
        	{
				break
        	}
        }

		InsBufLine(handle,process_line++, temp_buffer)
        InsBufLine(handle,process_line++," * !-->value1    [description]")
        InsBufLine(handle,process_line++," * !-->value2    [description]")
    }
    else
    {
		InsBufLine(handle,process_line++," * \@ReturnVal None")
    }

    sys_time = GetSysTime(1)
    temp_buffer = " * "
    temp_buffer = cat(temp_buffer,sys_time.Year)
    temp_buffer = cat(temp_buffer,"-")
    
    /* 月份和日期转为2位占位符 */
    len = strlen(sys_time.Month)
    if("@len@" == 1)
    {
	   temp_buffer = cat(temp_buffer,0)
    }
 	temp_buffer = cat(temp_buffer,sys_time.Month)
    temp_buffer = cat(temp_buffer,"-")
    
    len = strlen(sys_time.Day)
    if("@len@" == 1)
    {
	   temp_buffer = cat(temp_buffer,0)
    }
    temp_buffer = cat(temp_buffer,sys_time.Day)
    temp_buffer = cat(temp_buffer," WQC [初版作成]")

	InsBufLine(handle,process_line++," * \@History")
    InsBufLine(handle,process_line++,temp_buffer)
    InsBufLine(handle,process_line++," */")    
}

效果图
有形参有返回值在这里插入图片描述
有形参无返回值在这里插入图片描述
无形参有返回值
在这里插入图片描述

无形参无返回值在这里插入图片描述

  • 最后为我们添加的自定义宏函数定义快捷键
    1.点击Options->Key Assignments…在这里插入图片描述
    2.在Command的文本框中输入macro，找到我们自定义的宏函数，点击Assign New Key…，然后键入你想设置的快捷键方式即可
    在这里插入图片描述
source insight多行注释怎么做 source insight可以修改注释样式吗
tianpu2320959696的博客
01-19 413
例如，用户可以将SourceInsight与`Gprof`、`Valgrind`等性能分析工具结合使用，进行详细的性能分析和优化。本文将详细探讨“sourceinsight多行注释怎么做sourceinsight可以修改注释样式吗”，并进一步介绍SourceInsight如何优化代码，帮助用户更好地理解和使用这一工具。良好的代码格式是代码优化的重要方面。-重构工具：SourceInsight提供了基本的代码重构工具，如变量重命名、函数提取等，帮助用户重构代码结构，提升代码的可读性和可维护性。
source insight comment 添加代码注释
08-05
coding convention source insight comment
在sourceinsight中添加快速注释 Ctrl+/
晨曦烟火
12-07 1万+
功能描述： 在sourceinsight中添加快速注释 Ctrl+/ 操作步骤 1、用everything搜索文件：utils.em（C:\Program Files (x86)\Source Insight 3） 2、用sourceinsight打开文件：utils.em 3、在文件末尾添加下面代码 macro MultiLineComment() { hwnd =
linux学习【7】Sourc Insight 4.0设置+操作
最新发布
qq_20902063的博客
02-20 796
按照这个设置就可以了，下面的设置会标明设置理由。
Source Insight常用快捷键及注释快捷键设置
热门推荐
情义唯真，友谊方长存
06-10 5万+
在使用SI过程中，我根据自己的使用习惯修改了它的默认快捷键，并且在配置文件中添加了一些人性化功能，下面一一介绍： 修改快捷键：Options->Key Assignments...1.main window:Esc       2.Hight light:Middle Mouse3.Go Back:Alt+z              4.Go Forward:Alt+x    
SourceInsight快捷注释
Dokin
03-20 4830
SourceInsight没有内置代码快捷注释功能，需要在脚本中添加代码来实现。 具体操作步骤：打开Sourceinsight工程，在Project Name栏输入base，打开base工程，如下图所示。 打开base工程 在base工程中打开Utils.em文件，如下图所示。 打开Utils.em后，在代码的最后，加上以下代码。 /*注释多行代码的函数*/ macro MultiLineComment() { hwnd = GetCurrentWnd() ..
Source Insight添加快键键注释
ballack_linux的专栏
02-25 1139
Source InsightSource Insight不仅仅是一个强大的程序编辑器，它还能显示reference trees，class inheritance diagrams和call trees。Source Insight提供了最快速的对源代码的导航和任何程序编辑器的源信息。 Source Insight提供了快速和革新的访问源代码和源信息的能力。
Source Insight利用宏文件实现多行快速注释以及其他超级好用的功能
Happy_HZW的博客
09-01 4937
Source insight是一款非常优秀的代码阅读软件，但是有些地方还是不够完善，比如没有快速对一段代码进行注释的功能。对于此类需求，我们可以借助宏来实现。
source insight快速添加代码文件头注释和函数注释
kayshi的博客
09-26 5314
1：目的 通过快捷键来为代码快速添加头注释和函数注释 2：方法 1.打开base工程 2. 在utils.em下添加或修改下面的函数 2.1代码头部注释 /*获取文件名称*/ macro GetFileName(pathName) { nlength = strlen(pathName) i = nlength - 1 name = "" while (i + 1) { ch = pathName[i] if ("\\" == "@ch@") break i = i - 1 }
sourceinsight 代码行注释，去注释代码插件
04-07
本文将围绕"sourceinsight 代码行注释，去注释代码插件"这一主题，详细介绍如何使用自定义宏来实现快速的代码注释和去注释操作。 首先，我们关注的是"代码行注释"。在编程中，注释是必不可少的一部分，它用于解释...
sourceinsight 多行注释 批量注释 反注释
12-25
sourceinsight 多行 批量 注释 反注释 解压里面有readme.txt
Source Insight 注释快捷插件
12-17
在SourceInsight工程添加此文件，再设置快捷键CTL+/;之后就可以快速多行注释，单行注释，解开注释等，非常方便、
source insight 多行注释及反注释宏
07-04
已经更新，附上传送门：http://download.csdn.net/source/1587238 自己写的source insight注释宏，实现类似VC IDE的多行注释及反注释功能。使用方法：打开source insight的Base工程，选择Add and Remove Project Files，将Comments.em文件添加进Base工程，保存即可退出。打开其他任一工程，点击Options->Menu Assignments，在弹出对话框的左栏找到刚刚添加的Macro:Code2Comments并选中，在右栏的Menu下拉菜单中选择Work菜单，选中菜单中想要加入的位置后点击右侧Insert按钮即可。
SourceInsight代码注释插件：一键实现注释与去注释
3. 命令执行：宏通过执行SourceInsight的命令来完成注释和去注释的动作，这些命令可能包括插入字符串、替换文本等。 4. 环境适应性：好的宏代码会考虑到不同环境下的适应性，比如不同的缩进风格或者不同编程语言的...
source insight一键对齐
12-30
### 实现 Source Insight 中的一键对齐功能 在 Source Insight 编辑环境中，虽然内置了一定程度上的代码自动缩进支持，但对于复杂场景下的代码对齐需求可能无法完全满足[^1]。为了更好地处理这类问题并提高开发效率...
Source insight 批量注释方法
Dzp1994的博客
06-22 956
在使用Source insight进行开发时，有时需要多行注释功能。但source insight并没有这样的功能，需要额外的宏来实现。
Source Insight 4.0 快捷键设置多行注释与反注释
weixin_43387480的博客
03-04 1734
步骤三：点击Assign New Key按钮，然后关闭弹出的对话框，由于我喜欢的Ctrl+/已被Lookup Referefce…占用，所以就同时按下Ctrl+Shift+/快捷键。对于取消注释快捷键我使用了Ctrl+Shift+步骤二：在Command：中输入Edit:comment,会过滤后出现Edit:Comment Lines和Edit:Un-Comment Lines两行。其中，第一个是注释多上的，第二个是取消多行注释的。步骤一：Options—>Key Assignments,如下图。
Source Insight中快速添加注释
fjclc2008的专栏
05-25 2912
使用说明: 可以实现在sourceinsight中快速添加修改注释。 1. Project->Open Project... 打开Base工程(该工程一般在我的文档//Source Insight//Projects//Base中); 2. 搜索utils.em 里的字串"chenjsa" 改成自己的姓名 3. Project->Add and Remove Project Files... 加入宏文件(即utils.em); 4. Options->Menu As
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值