编码规范
文章平均质量分 67
COSummer
生物医学小硕一枚,现从事医疗软件研发
展开
-
软件编写规范(注释篇)
//摘抄自华为软件编写规范 1、:一般情况下,源程序有效注释量必须在 20 %以上 说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语 言必须准确、易懂、简洁。 2、说明性文件(如头文件.h 文件、.inc 文件、.def 文件、编译说明文件.cfg 等)头部应进行注释, 注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其原创 2017-06-25 11:35:43 · 6313 阅读 · 0 评论 -
VS2015秘钥、MVC框架的一点体会
将最近写代码的一些体会总结如下,希望下次可以不犯相同的错误,节省时间 1、现象:工程中有一对函数,但是没有调用,诡异的是程序走到这会崩溃,提示空指针 解决:分析call stack,发现实际是想调该函数上面的一个函数,之所以空指针,是因为内存里为随机数,所以原因是编译不对了,此时将所有代码rebuild,就可以了(试过只将问题代码所在工程rebuild,不见效果) 2、现象:使用M原创 2017-07-06 09:43:25 · 1252 阅读 · 1 评论 -
软件编码规范(宏篇)
//摘抄自华为软件编写规范 1、用宏定义表达式时,要使用完备的括号 示例:如下定义的宏都存在一定的风险。 #define RECTANGLE_AREA( a, b ) a * b #define RECTANGLE_AREA( a, b ) (a * b) #define RECTANGLE_AREA( a, b ) (a) * (b) 正确的定义应为: #define RECTAN原创 2017-06-25 20:09:16 · 1336 阅读 · 0 评论 -
软件编码规范(代码编辑、编译、审查 )
//摘抄自华为软件编写规范 1、某些语句经编译后产生告警,但如果你认为它是正确的,那么应通过某种手段去掉告警信息 说明:在 Borland C/C++中,可用“#pragma warn”来关掉或打开某些告警。 示例: #pragma warn -rvl // 关闭告警 int examples_fun( void ) { // 程序,但无 return 语句。原创 2017-06-25 19:46:23 · 663 阅读 · 0 评论 -
软件编写规范(质量保证篇)
//摘抄自华为软件编写规范 1、过程/ 函数中申请的(为打开文件而使用的)文件句柄,在过程/ 函数退出之前要关闭 说明:分配的内存不释放以及文件句柄不关闭,是较常见的错误,而且稍不注意就有可能发生。这类错误往往会引起很严重后果,且难以定位。 示例:下函数在退出之前,没有把分配的内存释放。 typedef unsigned char BYTE; int example_fun( BYT原创 2017-06-25 19:30:20 · 952 阅读 · 0 评论 -
软件编写规范(程序效率篇)
//摘抄自华为软件编写规范 1、编程时要经常注意代码的效率 说明:代码效率分为全局效率、局部效率、时间效率及空间效率。全局效率是站在整个系统的角度上的系统效率;局部效率是站在模块或函数角度上的效率;时间效率是程序处理输入任务所需的时间长短;空间效率是程序所需内存空间,如机器代码空间大小、数据空间大小、栈空间大小等。 2、在保证软件系统的正确性、稳定性、可读性及可测性的前提下,提高代码效率原创 2017-06-25 18:56:38 · 962 阅读 · 0 评论 -
编码规范(函数、过程篇)
//摘抄自华为软件编写规范 1、对所调用函数的错误返回码要仔细、全面地处理 2、防止将函数的参数作为工作变量 说明:将函数的参数作为工作变量,有可能错误地改变参数内容,所以很危险。对必须改变的参数,最好先用局部变量代之,最后再将该局部变量的内容赋给该参数。 示例:下函数的实现不太好。 void sum_data( unsigned int num, int *data, int *sum原创 2017-06-25 18:16:52 · 2561 阅读 · 0 评论 -
编码规范(变量、结构篇)
//摘抄自华为软件编写规范 1、去掉没必要的公共变量 说明:公共变量是增大模块间耦合的原因之一,故应减少没必要的公共变量以降低模块间的耦合度。 2、仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系 说明:在对变量声明的同时,应对其含义、作用及取值范围进行注释说明,同时若有必要还应说明与其它变量的关系。 3、明确公共变量与操作此公共变量的函数或过程的关系,如访问、修改及创建原创 2017-06-25 15:43:07 · 1606 阅读 · 0 评论 -
软件编写规范(可读性)
//摘抄自华为软件编写规范 1、注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级 说明:防止阅读程序时产生误解,防止因默认的优先级与设计思想不符而导致程序出错。 word = (high << 8) | low (1) if ((a | b) && (a & c)) (2) if ((a | b) < (c & d)) (3) 如原创 2017-06-25 14:13:14 · 1004 阅读 · 0 评论 -
软件编写规范(标识符命名)
//摘抄自华为软件编写规范 1、标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解 说明:较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成缩写;一些单词有大家公认的缩写。 示例:如下单词的缩写能够被大家基本认可。 temp 可缩写为 tmp ; flag 可缩写为 flg ; statisti原创 2017-06-25 13:56:42 · 2348 阅读 · 0 评论 -
软件编写规范(排版篇)
//摘抄自华为软件编写规范 1、较长的语句(>80 字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读 。perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof(原创 2017-06-25 10:50:10 · 717 阅读 · 0 评论 -
时序图
一、定义 时序图(Sequence Diagram),又名序列图、循序图、顺序图,是一种UML交互图。它通过描述对象之间发送消息的时间顺序显示多个对象之间的动态协作。它可以表示用例的行为顺序,当执行一个用例行为时,其中的每条消息对应一个类操作或状态机中引起转换的触发事件。二、时序图中包括如下元素:角色,对象,生命线,控制焦点和消息。 1、角色(Actor) 系统角色,可以是人或者其他系统,子原创 2017-09-25 11:30:22 · 4913 阅读 · 0 评论