写给大家看的编程规范

(本文參加 2014 CSDN博文大赛。谢谢。

)

【文章摘要】

       “没有规矩。不成方圆”，在实际的软件开发项目中。做不论什么事情都不是随心所欲的，我们编写代码须要遵守项目组约定的编程规范。

非常遗憾。在学校的计算机课程中，重在教导学生实现一定的程序功能。对程序的编写规范非常少提及，这也就导致了从学校毕业踏上工作岗位之后一段艰辛的学习过程。

       本文依据自身的软件开发实践，对实际的软件开发项目中编写C语言和SQL语言程序时所需遵守的规范进行了具体的介绍。旨在让广大即将从事软件开发工作的程序猿们懂得编程规范的重要性，以编写出整洁美观的代码，并从容面对未来的工作。

【关键词】

       C语言  SQL语句  编程规范  开发  流程

 

第一部分 C语言编程规范

       在通信类软件中，C语言是经常使用的编程语言。

在编写C语言程序的过程中，我们须要遵守的编程规范包含：

       1. 程序的版式和凝视

       在C语言程序中。一般都包含了头文件(.h文件)和源文件(.c文件)，它们的版式及凝视例如以下：

       第一，头文件的版式和凝视。

       头文件起到了一个辅助的作用。简要地反应出本程序的基本功能。头文件的内容包含：宏定义、结构体定义、函数的声明等。头文件的版式可採用下面的样式：

 

       第二。实现文件的版式和凝视。

       源文件(.c)文件是程序的核心。全部的工作都是在里面完毕的。该文件中面主要是一些函数的实现。源文件可採用下面的版式来书写：

 

       函数实现是程序的核心，函数头部的可採用例如以下的版式：

        2. 变量及函数的命名

       本小节下面面的代码为例进行说明：

 

       有关变量及函数的命名。说明例如以下：

       (1) 变量命名和函数命名应具备描写叙述性，不要过度缩写。变量的命名应该使用名词。如fResult；函数的命名应该使用“命令性”动词，如ProcessFactorial。

       (2) 无论是函数还是变量，它们的命名仅仅有一个原则：让读者一眼就行看出它们表达的意思。

如ProcessFactorial函数。一看到它。就大概可以明确这是在求阶乘(假设你英语确实不好，那就另当别论了)。iInputValue变量，表示输入值；fResult变量，表示结果值。

我们要让代码自己来说话。而不是要作者向别人解释半天才行。

       (3) 为了让读者看到一个变量就知道其类型。在变量的最前面，一般会有一个标识类型的字母。如iInputValue中的第一个字母“i”表示这是一个整型变量(“i”代表“int”)，fResult中的第一个字母“f”表示这是一个浮点型变量(“f”代表“float”)。

这样做，也是为了更进一步让读者对代码可以了然于心，可以非常easy读懂。这样也省去了作者非常多向别人解释的时间。

       (4) 函数的功能要单一，不要设计多用途的函数；函数体的规模要小，将函数内的代码行数控制在项目中规定的范围之内。此外，要尽量避免函数带有“记忆”功能。同样的输入应该产生同样的输出。

       (5) 始终要明确，我们第一是为人编写代码，其次才是计算机。假设仅仅是计算机可以读懂的代码，不是好代码。也无法体现出一个编程人员的水平。

 

        3. 有关C语言的其他编程规范

        编写出整洁美观的代码是对一个开发者的基本要求，有关C语言的其他编程规范及相关内容。请阅读本人CSDN博客专栏《软件项目实践中的C语言一瞥》：http://blog.csdn.net/column/details/anotherc.html。

 

 

第二部分 SQL语言编程规范

       通信类软件中。经常须要处理大量的用户信息。这就须要与数据库打交道。在编写SQL语言程序的过程中。我们须要遵守的编程规范包含(为了方便说明。本部分的全部代码均是基于Sybase数据库实现)：

       1. SQL文件的布局

       SQL脚本代码布局示比例如以下：

 

        2. SQL脚本的凝视

        凝视在SQL脚本的编写中占有非常重要的地位。优美的、得当的凝视不仅有助于研发人员理解程序。还可以提高编程效率。

        (1) 文件头部的凝视

        (2)    文件摘要信息的凝视

        (3)    表或存储过程开头处的凝视

 

       (4)    表的各字段之后的凝视

 

        (5)    存储过程的凝视

        3. 数据库表及索引的创建

        要做到字段命名恰如其分，并在适当的字段上建立索引。

样比例如以下：

  

       4. 有关SQL语言的其他编程规范

      有关SQL语言的其他编程规范包含：空行与空格、begin与end的使用，数据操纵语言(DML)的书写等。详见本人CSDN博客(http://blog.csdn.net/zhouzhaoxiong1227?viewmode=contents)有关SQL语言的内容。

 

 

       编写出规范的代码。不仅可以体现出一个软件开发者的专业素养，还可以反映出一个人做事的态度。

作为一个合格的软件开发project师，我们一定要时刻将编程规范牢记心中，做出高质量的软件来。

       最后。附上一个典型的、规范的软件研发流程图。

(本人CSDN博客：http://blog.csdn.net/zhouzhaoxiong1227?

viewmode=contents，微博：http://weibo.com/zhouzxi?topnav=1&wvr=5。微信号：245924426，欢迎关注。)