下载文档原格式
C语言软件编程规范拟定：黄宗灯日期：2019-01-25评审：日期：批准：日期：Revision Record修订记录Date 日期RevisionVersion修订版本SecNo.修改章节Change Description修改描述Author作者2019-01-25v1.0All initial初稿完成黄宗灯关键词：编程规范、软件开发规范、规则、建议、规范摘要：本文描述了宇眼科技C语言在设计和编码过程中，需要遵循的一些基本规范。
缩略语清单：Abbreviations缩略语Full spelling英文全名Chinese explanation中文解释ppf Police Platform警用平台cpf Car Platform汽车平台fpf Fire Control Platform消防平台ueyes UEYES宇眼科技1.概述1.1.目的制定本规范的目的是在宇眼科技的开发和维护过程中，统一设计规范和编程规范，便于提高开发效率，统一风格，提高软件质量和可维护性。
1.2.本规范所规定的内容1）目录组织结构，文件命名，头文件组织；2）在函数设计、实现过程中所遵循的一些规范；3）在调试，维护，源程序管理等其他方面的一些规范；4）组件设计、裁减及配置方面的规范；采用以下的术语描述：规则：工作过程中强制必须遵守的原则建议：工作过程中必须加以考虑的原则说明：对此规则或建议进行必要的解释2.目录结构规范由于Unix、Linux下对字母大小写敏感，为减少出错的机率，统一规定宇眼科技所有目录名都使用小写。
3.文件组织3.1.文件类型及命名规则3-1-1：宇眼科技的源程序文件有如下类型的文件：头文件：*.h程序文件：*.c规则3-1-2：文件名必须为小写字母；说明：由于Unix、Linux下对文件名大小写敏感，为减少因此出错的概率，统一规定使用小写字母。
规则3-1-3：文件名前加一个表示模块的前缀以避免重名；示例：ply_ui.c具体前缀请参考：4.1标识定义；规则3-1-4：几种特殊类型的文件命名如下：xxx_interface.h：模块的对外（提供给其他模块使用的接口）的头文件，使用该模块时需要包含的头文件；例如：ply_interface.h3.2.文件内容组织规则3-2-1：公用头文件包含需要全局引用的宏定义、变量说明、结构说明和外部函数声明等。
1、背景色选择要改变背景色Options->preference->windows background->color设置背景色2、解决字符等宽对齐问题。
Options-> Document Options里面的“Screen Fonts" SIS默认字体是VERDANA，很漂亮。
这网页上应该也是用的VERDANA字体。
但由于美观的缘故，VERDANA字体是不等宽的。
比如下面两行llllllllllMMMMMMMMMM同样10个字符，长度差多了.用VERDANA来看程序，有些本应该对齐的就歪了。
解放方法是使用等宽的字体，但肯定比较丑。
比较推荐的是用Courier New。
3、解决TAB键缩进问题Options-> Document Options里面的右下角Editing Options栏里，把Expand tabs勾起来，然后确定。
OK，现在TAB键的缩进和四个空格的缩进在SIS里面看起来就对齐咯4、SI中的自动对齐设置:在C程序里, 如果遇到行末没有分号的语句,如IF, WHILE, SWITCH等, 写到该行末按回车，则新行自动相对上一行缩进两列。
Option->Document option下的Auto Indient中Auto Indient Type有三种类型 None,Simple,Smart。
个人推荐选用Simple类型。
5、向项目中添加文件时，只添加特定类型的文件（文件类型过滤器）编辑汇编代码时，在SIS里建立PROJECT并ADD TREE 的时候，根据默认设置并不会把该TREE里面所有汇编文件都包含进来只加了.inc和.asm后缀的，.s后缀的没有。
而且用SIS 打开.s的文件，一片黑白没有色彩，感觉回到DOS的EDIT 时代了……解决方法是在Options->Document Options里面，点左上的Document Type下拉菜单，选择x86 Asm Source File，然后在右边的File filter里*.asm；*.inc；的后面加上*.s；接着CLOSE就可以了。
SourceInsight4.0安装使⽤教程⼀、说明Source Insight是什么：Source Insight是⼀款代码编缉、浏览、分析⼯具。
Source Insight与⽂本编缉器有什么区别：Notepad++等⽂本编缉器也可以编缉、浏览代码，但分析能⼒就⽐较弱；如跳转函数定义处、跳转函数调⽤处等都⽆能为⼒。
Source Insight与集成开发环境有什么区别：IDE除了代码编缉、浏览、分析外还能编译、调试、运⾏；Source Insight还能存在主要是在分析⽅⾯做得更好：⼀是多了⼀个调⽤函数上下⽂窗⼝、⼆是项⽬全局查找功能⽐较好、三是前进后退⽐较好。
总⽽⾔之，⼀⽅⾯Source Insight是代码分析较好的⼯具。
另⼀⽅⾯也不⽤太极端凡代码风析必Source Insight，你想⽤IDE想⽤Notepad都是可以的。
另外，我们这⾥⼀直说代码分析⽽不说代审计，是因为Source Insight和Wireshark⼀样并不只是为安全⼈员设计的，⼀般的程序员也会⽤。
分析侧重于弄懂整个代码流程，审计侧重于在理解代码基础上找出漏洞。
⼆、安装Source Insight是收费软件⽽我们喜欢使⽤学习版，加上安装也就是双击安装就可以了，就不多说了。
可参考链接：三、使⽤3.1 创建项⽬启动Source Insight界⾯如下图，依次点击Project----New Project创建项⽬New project name----这⾥的project name是Source Insight中起的项⽬名，⽽不是待审计的项⽬的项⽬名，也就是说不管后边要审计什么项⽬这⾥想起什么名字都可以。
但为了⽅便起见还是建议填的项⽬名与后续要审计的项⽬名⼀致。
⽐如我这⾥后续要审计⼀个叫BankSystem 的项⽬，这⾥的New project name也就填BankSystem。
Where do you want to store the project data files?----这个⽬录是⽤于存放记录代码审计过程中的操作步骤、配置的⽂件，⽽不是待审计项⽬、代码的位置，这点要搞清楚。
1Source Insight 3.5使用教程一、建立工程：1． 在桌面上新建一个保存工程文件的文件夹，文件夹取名为project ，如图1所示。
（当然您可以在你任何路径下建立文件夹，文件夹的名称也可随意取。
）2． 将要加入工程中的源文件（*.h,*.c 等），都拷贝到建立的project 文件夹中。
图13． 打开Source Insight 3.5软件进入图2界面。
图24．点击菜单“Porject→New Project”进入图35．图3中弹出的New Project对话框内，修改您要建立的工程名称，在此我们改成test；再点击Browse选择您要保存的路径，在本例我们选择第1步中建立的project 文件夹，即C:\Documents and Settings\tang03\桌面\project。
如图4：图426．点击图4中的New Project的“OK”按纽后进入新工程设置如图5所示界面，在此我们按图5中的选择进行设置后，点击“OK”确定，进入图6所示界面。
图57．在图6中，我们要选择要加入工程中的源文件。
在“Add and Remove Project Files”对话框中的“Files Name”栏目下点击选中任一你想加入到工程中的文件，比如：I2C.C 文件，再点击右侧的“ADD”按纽即可将I2C.C文件加入工程，如图7和8所示。
图634图7图88．如果Directory栏下的“project“文件夹中所有的文件都需要加入工程，那么，只需要点击右侧的“ADD All”按纽即可将所有文件加入工程。
9．所有文件都加入到工程后，点击“Add and Remove Project Files”对话框中右上角的“Close”后，进入图9所示界面。
图9510．双击图9右侧区的“File Name区”中的Main.c即可打开Main.c文件，进入图10界面。
图10中共有4个区：左侧显示main.c文件中的所有变量、函数、包含文件的名称（双击该区的任意一项，会在中间区域显示出它的实体，如图11所示）；中间区显示main.c的内容；右侧区显示整个工程中的文件；最下方的区域为关联区，如图10所示显示，当鼠标放置在中间区域的SCI1_INIT()函数后，在下放关联区会立刻调出SCI1_INIT()的实体。
Source Insight教程默认分类2007-07-11 16:28:22 阅读111 评论0 字号：大中小SourceInsight,从软件的英文名字上来解读就是“深入到源代码”，该软件只具有代码的阅读、编辑和简单的语法检查功能，而不具有编译等功能。
尤其是在阅读大规模工程代码的时候，SourceInsight 在代码导航、高亮注释，颜色区分，代码关联等，在编辑功能上稍稍有所欠缺，尤其是需要经常在键盘和鼠标之间切换，但是如果你对快捷键掌握比较熟悉的话，这个是可以稍稍避免的。
对于编辑功能上，竞争软件有很多如：Vim，Ultra Edit等。
图片教程如下：快捷键集锦：Ctrl+= :Jump to definitionAlt+/ :Look up referenceF9 :Jump to next referenceF7 :Look up symbolsF8 :Look up local symbolsF9 :Ident leftF10 :Ident rightAlt+, :Jump backwordAlt+. : Jump forwardF2: switch to next pageF3 : search backwardF4 : search forwardF5: Jump to line ?Ctrl+,/Ctrl+. Jump to last/pastShift+F3 : search the word under cursor backwardShift+F4 : forwardF12 : incremental searchShift+Ctrl+f : search in projectOthers(Common in Windows system)Shift+Tab: Moving foward(After text selected)Tab:Moving backward(After text selected)Shift+(Up,Down,Left,Rght):Select code,do not have to using mouse cursor退出程序: Alt+F4 重画屏幕: Ctrl+Alt+Space 完成语法: Ctrl+E 复制一行: Ctrl+K 恰好复制该位置右边的该行的字符: Ctrl+Shift+K复制到剪贴板: Ctrl+Del 剪切一行: Ctrl+U 剪切该位置右边的该行的字符: Ctrl+; 剪切到剪贴板: Ctrl+Shift+X 剪切一个字: Ctrl+, 左边缩进: F9右边缩进: F10 插入一行: Ctrl+I 插入新行: Ctrl+Enter加入一行: Ctrl+J 从剪切板粘贴: Ctrl+Ins 粘贴一行: Ctrl+P重复上一个动作: Ctrl+Y 重新编号: Ctrl+R 重复输入: Ctrl+\替换: Ctrl+H 智能重命名: Ctrl+' 关闭文件: Ctrl+W关闭所有文件: Ctrl+Shift+W 新建: Ctrl+N 转到下一个文件: Ctrl+Shift+N 打开: Ctrl+O 重新装载文件: Ctrl+Shift+O 另存为: Ctrl+Shift+S显示文件状态: Shift+F10 激活语法窗口: Alt+L 回到该行的开始: Home回到选择的开始: Ctrl+Alt+[ 到块的下面: Ctrl+Shift+] 到块的上面: Ctrl+Shift+[书签: Ctrl+M 到文件底部: Ctrl+End, Ctrl+(KeyPad) End到窗口底部: (KeyPad) End (小键盘的END) 到一行的尾部: End到选择部分的尾部: Ctrl+Alt+] 到下一个函数: 小键盘+ 上一个函数: 小键盘–后退: Alt+,, Thumb 1 Click 后退到索引: Alt+M 向前: Alt+., Thumb 2 Click转到行: F5, Ctrl+G 转到下一个修改: Alt+(KeyPad) +转到下一个链接: Shift+F9, Ctrl+Shift+L 回到前一个修改: Alt+(KeyPad) –跳到连接(就是语法串口列表的地方) : Ctrl+L 跳到匹配: Alt+]下一页: PgDn, (KeyPad) PgDn 上一页: PgUp, (KeyPad) PgUp向上滚动半屏: Ctrl+PgDn, Ctrl+(KeyPad) PgDn, (KeyPad) *向下滚动半屏: Ctrl+PgUp, Ctrl+(KeyPad) PgUp, (KeyPad) / 左滚: Alt+Left向上滚动一行: Alt+Down 向下滚动一行: Alt+Up 右滚: Alt+Right选择一块: Ctrl+- 选择当前位置的左边一个字符: Shift+Left选择当前位置右边一个字符: Shift+Right 选择一行: Shift+F6从当前行其开始向下选择: Shift+Down 从当前行其开始向上选择: Shift+Up选择上页: Shift+PgDn, Shift+(KeyPad) PgDn 选择下页: Shift+PgUp, Shift+(KeyPad) PgUp选择句子(直到遇到一个. 为止) : Shift+F7, Ctrl+. 从当前位置选择到文件结束: Ctrl+Shift+End 从当前位置选择到行结束: Shift+End 从当前位置选择到行的开始: Shift+Home从当前位置选择到文件顶部: Ctrl+Shift+Home 选择一个单词: Shift+F5选择左边单词: Ctrl+Shift+Left 选择右边单词: Ctrl+Shift+Right到文件顶部: Ctrl+Home, Ctrl+(KeyPad) Home 到窗口顶部: (KeyPad) Home到单词左边(也就是到一个单词的开始) : Ctrl+Left 到单词右边(到该单词的结束) : Ctrl+Right 排列语法窗口(有三种排列方式分别按1,2,3次) : Alt+F7 移除文件: Alt+Shift+R同步文件: Alt+Shift+S 增量搜索(当用Ctrl + F 搜索,然后按F12就会转到下一个匹配) : F12 替换文件: Ctrl+Shift+H 向后搜索: F3 在多个文件中搜索: Ctrl+Shift+F向前搜索: F4 搜索选择的(比如选择了一个单词,shift+F4将搜索下一个) : Shift+F4 搜索: Ctrl+F 浏览本地语法(弹出该文件语法列表窗口,如果你光标放到一个变量/函数等,那么列出本文件该变量/函数等的信息) : F8 浏览工程语法: F7, Alt+G跳到基本类型(即跳到原型) : Alt+0跳到定义出(也就是声明) : Ctrl+=, Ctrl+L Click (select), Ctrl+Double L Click 检查引用: Ctrl+/语法信息(弹出该语法的信息) : Alt+/, Ctrl+R Click (select) 高亮当前单词: Shift+F8语法窗口(隐藏/显示语法窗口) : Alt+F8 关闭窗口: Alt+F6, Ctrl+F4最后一个窗口: Ctrl+Tab, Ctrl+Shift+Tab。
Source Insight使用简单说明Source Insight是一个功能十分强大、使用也很方便的程序编辑器。
它内置对C/C++、Java 甚至x86汇编语言程序的解析，在你编程时提供有用的函数、宏、参数等提示，因而，Source Insight正在国际、国内众多的IT公司使用。
Source Insight功能强大，它的窗口、菜单初一看来似乎很多，所以刚刚开始使用Source Insight的朋友往往觉得很麻烦。
这里本人结合自己的使用经验，简单说说Source Insight的使用。
(本文以McuSystem为例，Source Insight 以3.0版本为例。
其他版本的Source Insight 大同小异)和众多程序编辑环境一样，Source Insight中也有Project。
建立工程的方法很简单：1.打开Source Insight，选择Project菜单->New Project；2.在出现的对话框中选择并选择存放工程文件的文件夹，输入工程名（比如McuSystem），点击“保存”；3.又出现一个对话框，在Configuration部分可以选择这个工程使用全局配置文件还是自己单独的配置文件，这个无所谓，（不过最好选择单独的配置文件），再点击“OK”；4.再次出现一个对话框，这是选择文件添加到Project中，通过左边的树状图找到你想添加的文件，点击Add就可以了（如图1）。
你可以将不通路径下的文件添加到同一个工程中，而不用拷贝源文件。
选择完后点击Close；图1这样工程就建立好了，文件列表就出现在Project Window中（如果Project Window被关闭了，可以选中View菜单->Project Window）。
点击Project Window中任意一个文件，文件的内容出现在中央的编辑区了。
（如图2）图2如果工程已经建立好了，想要打开、关闭、删除工程，直接点击Project菜单下相应的选项就可以了，这里就不多说了。
ubuntu下安装source insight1. 安装wine详看：/WineJava代码1.sudo apt-get install wine因为版本比较旧，所以通常不用，改用PPA中的wine。
安装最新版wineubuntu 官方自带了wine ，但是推荐用winehq 官方提供的最新版本wine ，新版本解决了很多以前显得麻烦的问题。
PPA地址：https:///~ubuntu-wine/+archive/ppaJava代码1.sudo add-apt-repository ppa:ubuntu-wine/ppa2.sudo apt-get update3.sudo apt-get install wine2.安装winetricksJava代码1.wget /wine/winetricks改变权限，剪切到：/usr/local/binJava代码1.chmod +x winetricks2.sudo mv winetricks /usr/local/bin使用winetricks，安装软件，例如安装.net2.0框架Java代码1.winetricks dotnet203.安装source insight下载地址：/downeval.html使用命令wine *.exe（刚下载的source insight软件）开始安装source insightubuntu中Application/wine/Programs打开source insight新建project，导入android源码即可。
4.卸载wine删除主要文件Java代码1.sudo apt-get remove --purge wine删除残留文件（1）删除.config/menus目录下的相应文件（2）删除.config/menus/applications-merged目录下的相关文件（3）打开.config/menus/applications.menu文件，删除文件中与wine有关的内容。
Source Insight 的实用技巧1 开胃菜-初级应用1.1 选择美丽的界面享受工作虽然不能以貌取人，但似乎从来没有人责备以貌取软件的。
SI的华丽界面，绝对符合现代花花世界的人的审美趣味。
在SI中，我们可以轻松地把各种类型关键字、变量、标志符、函数、宏、注释等定义为不同的颜色和显示方式(正体或斜体、加粗或正常、加下划线、放大显示等)，总有一种方式能让我们一眼就能分辨出这个标识是什么。
1.1.1 字体选择在SI中样式是可以被继承，如果要从根本上改变字体，最简单的方式就是直接修改根样式中的字体，因为其它样式都会由此继承而来。
选择Options/Document Options页面内的Font Options中的Screen Fonts字体，即可改变根样式中的字体。
SI中的默认配置为Verdana字体，是一种非等宽字体2，为了使编写的代码在各种编辑器中看起来都有良好的对齐效果，这里强烈建议使用等宽字体，Courier、New Courier和宋体等都是较好的选择。
1.1.2 颜色定义毕竟这是见仁见智的东西，所以从来没有统一的标准3。
很多人并不喜欢SI提供的默认配置，那么我们就改吧。
选择Options/Style Properties页面，就可以在其中修改所有样式了。
选择等号(=)表示继承Parent Style，也可以选择Pick(或者ON/OFF等)去配置一个新值。
这完全视乎个人喜好。
1.1.3 标识符样式选择在与颜色定义一节同样的界面内即可完成此项配置。
1.1.4 背景色选择在希望要改变背景色的窗口点击鼠标右键(假定使用的是右手鼠标4)，选择上下文菜单的 xxx Window Properties项，然后点击弹出窗口的Back Color按钮，即可修改该窗口背景色。
对于SI的源码主窗口，只需选择上下文菜单的Special Window Color项即可完成背景色修改。
1.2 配置合理的默认值高效工作1.2.1 使用合理的缩进我始终认为最容易获得认同的是关于这个选项的配置了。
