2024年4月13日发(作者：)

使用Source insight生成程序模板的说明

版 本

1.0

描 述

初稿

本 起始日期

2001-12-24 / 2001-12-24

1.1

1.2

1.3

增加宏说明

更新了

热键定义

2002-1-29

2002-6-10

2002-6-14

写作目的

本文主要的目的为了给大家介绍一个利用source insight 快速生成符合《软件编程规范》

要求的原程序和函数注释的工具。

1 使用该工具的准备工作

1.1 建立一个source insight 的符号查找工程

1. 打开source insight的project，选择base。

2. 在base 工程中加入

3. 在菜单options中选中prefenrences的symbal lookups，然后将工程base加到project symbal path中

去（通过add project to path）。

4．确认

1.2 建立自己的sourceinsight热键

自定义：

进入菜单options中的Key assignment后，将宏定义为热键。

推荐热键定义：

打开sourceinsight；选择options；选择load configuration；disable all；选择keys；选中3,； ok；

常用sourceinsight宏一览表：

Macro名称（带*号的

为常用宏定义）

sun_InsertHeader * 生成函数的注释框架

功能描述 推荐热键定

义

Ctrl +Al+f或

Alt+f

Sun_InsertHFileHeader * 生成h文件的注释框架 Ctrl +Alt+h或

Alt+h

Sun_InsertCFileHeader * 生成c文件的注释框架 Ctrl +Alt+c或

Alt+c

sun_InsertHeaderUpdata * 在光标所在行插入函数更新记录

（用于在文件头部注释）

sun_InsertSpaceComment* 插入空白注释（用于加入更新记录）

Sun_comment * 在光标所在行加入用户注释

sun_CheckFile * 自动整理单个文件中由生成的注释

Ctrl+Alt+s

Ctrl+Alt+m

Ctrl+Alt+k

Ctrl +Alt+u

sun_CheckProjFile

sun_tolower

sun_toupper

sun_AutoExpand

自动整理工程中所有文件中由生成的注释 Ctrl+Alt+p

所选字符转为小写

所选字符转为小写*

Ctrl+u

Ctrl+shift+u

输入if 、for 、while、switch、elseif和case等、 Ctrl+Alt+a

可以自动帮你生成代码框架

sun_undef *

sun_undefelse

sun_undefstar

用于自动对选中代码加#if 0 #endif

用于自动对选中代码加#if 0 #else #endif

用于自动对选中代码加/* */

Ctrl+Alt+0

Ctrl+Alt+e

Ctrl+Alt+8

1.3 建立一个用户环境变量MYNAME

环境变量MYNAME用于表述用户的个人信息

一般设置为个人姓名,如set MYNAME= sun（在控制面板/系统/高级）

如未设置该变量，该工具缺省认为MYNAME为“未知”

2 如何使用该工具

2.1 工作环境要求（必要准备）

2.1.1 该工具是所有功能均要求在已完成上一章节的前提的source sight编辑环境中使用。

2.1.2 要求系统时钟显示为中文或英文格式，否则不能保证自动生成时间格式的正确性

2.1.3 为了保证注释格式的美观，请将source sight的screen fonts设置为等宽字体（如

Courier）

2.2 生成c、h文件注释框架

1. 首先建立一新文件，并命名。

2. 在该文件的编辑状态，执行相关热键。

3. 对于其中的文件功能描述、文件所属模块、修改日志和版本等信息由程序员自己完成。

2.3 生成函数注释

1． 将光标移至一个完成函数处（可以仅仅是包括参数函数框架）

2． 执行相关热键。

3． 对于其中的参数说明、功能描述、和注意事项由使用者自己完成

其中参数说明根据《软件编程规范》要求，需要指定是输入输出（IN/OUT）