SourceInsight代码编写辅助工具V1.0的使用.pdf

SourceInsight代码编写辅助工 具的使用 老边饺子: tacj1975@126.com 工欲善其事，必先利其器 功能 添加代码修改说明 添加代码注释 添加#if 0 －#endif注释 添加函数说明 添加文件说明 以上功能均由工具自动完成，您只 需按一个快捷键即可。 添加代码修改说明I 这个功能比较适合于修改 BugBase中的问题单 如果当前光标只选中了一行代 码，格式如下 ： a = 1;/*Modifed by CuiJin on 2003年6月29 日Version(NetEye3.2)*/ 添加代码修改说明II 如果当前光标选中了多行代码，格 式如下： /*Start of CuiJin on 2003年6月29 日 NetEye3.2*/ if( x == y ){ a = 1; }else{ a = 0; } /*End of CuiJin on 2003年6月29 日 NetEye3.2*/ 添加代码修改说明III 通常可能是先修改了M行代码，隔几行后又 修改了N行。这时，如果整个修改的部分比 较集中 （如在20行以内 ），则使用一次多 行修改说明就可以了，用不着每次都加说 明，那样的话有喧宾夺主的感觉。 说明中的CuiJin指实际代码的修改人，后面 的NetEye3.2指代码所属的版本，可能包括 子版本 。这两项都可以通过宏自动设置 （后面介绍）。 添加代码注释 只选择了一行代码，格式如下： //a = 1; 选中了多行代码 /*if( x == Y ){ a = 1; }else{ a = 0; }*/ 添加#if 0 －#endif注释I 在实际工作中，往往遇到这种情况：代码经过多 次修改，已经添加过/**/组合 。这样如果再次 加就不能完全将代码注释掉，如下： /*/*a = 1; b = 100;*/ c = 200;*/ 实际上，黄色部分并没有被注释掉，也就是说第 二次添加的注释信息没有起到应有的作用。 添加#if 0 －#endif注释II 解决方案 使用#if 0 －#endif组合，即刻搞定： #if 0 /*a = 1; b = 100;*/ c = 200; #endif 函数说明的自动添加 完全符合部门的编程规范 /* * Function: * Description: * Calls: * Called By: * Table Accessed: * Table Updated: * Input: * Output: * Return: * Others: */ 文件说明的自动添加 同样符合部门的编程规范 /* * FileName: * Author: CuiJin Version: NetEye3.1 Date:2003.6.29 * Description: * Version: * Function List: * 1. * History: * author time version desc */ 其中的作者、版本、日期信息是自动添加的 菜单项分类说明 SaveSysInfo－保存你的基本信息。注意这 是第一个要操作的菜单 ！ AddModInfo －添加修改代码说明信息 AddCommentInfo －添加代码注释信息 AddIf0Identifier －添加#if 0 －#endif注释信 息 AddFuncHeader －添加函数说明信息 AddFileHeader －添加文件说明信息