什么是好的程序.docx

什么是好的程序.docx

《什么是好的程序.docx》由会员分享，可在线阅读，更多相关《什么是好的程序.docx（15页珍藏版）》请在冰豆网上搜索。

什么是好的程序

什么是好的程序员？

是不是懂得很多技术细节？

还是懂底层编程？

还是编程速度比较快？

我觉得都不是。

对于一些技术细节来说和底层的技术，只要看帮助，查资料就能找到，对

于速度快，只要编得多也就熟能生巧了。

我认为好的程序员应该有以下几方面的素质：

  1、有专研精神，勤学善问、举一反三。

  2、积极向上的态度，有创造性思维。

  3、与人积极交流沟通的能力，有团队精神。

  4、谦虚谨慎，戒骄戒燥。

  5、写出的代码质量高。

包括：

代码的稳定、易读、规范、易维护、专业。

这些都是程序员的修养，这里我想谈谈“编程修养”，也就是上述中的第5点。

我觉得，如

果我要了解一个作者，我会看他所写的小说，如果我要了解一个画家，我会看他所画的图

画，如果我要了解一个工人，我会看他所做出来的产品，同样，如果我要了解一个程序员

，我想首先我最想看的就是他的程序代码，程序代码可以看出一个程序员的素质和修养，

程序就像一个作品，有素质有修养的程序员的作品必然是一图精美的图画，一首美妙的歌

曲，一本赏心悦目的小说。

我看过许多程序，没有注释，没有缩进，胡乱命名的变量名，等等，等等，我把这种人统

称为没有修养的程序，这种程序员，是在做创造性的工作吗？

不，完全就是在搞破坏，他

们与其说是在编程，还不如说是在对源程序进行“加密”，这种程序员，见一个就应该开

除一个，因为他编的程序所创造的价值，远远小于需要在上面进行维护的价值。

程序员应该有程序员的修养，那怕再累，再没时间，也要对自己的程序负责。

我宁可要那

种动作慢，技术一般，但有良好的写程序风格的程序员，也不要那种技术强、动作快的“

搞破坏”的程序员。

有句话叫“字如其人”，我想从程序上也能看出一个程序员的优劣。

因为，程序是程序员的作品，作品的好坏直截关系到程序员的声誉和素质。

而“修养”好

的程序员一定能做出好的程序和软件。

有个成语叫“独具匠心”，意思是做什么都要做得很专业，很用心，如果你要做一个“匠

”，也就是造诣高深的人，那么，从一件很简单的作品上就能看出你有没有“匠”的特性

，我觉得做一个程序员不难，但要做一个“程序匠”就不简单了。

编程序很简单，但编出

有质量的程序就难了。

我在这里不讨论过深的技术，我只想在一些容易让人忽略的东西上说一说，虽然这些东西

可能很细微，但如果你不注意这些细微之处的话，那么他将会极大的影响你的整个软件质

量，以及整个软件程的实施，所谓“千里之堤，毁于蚁穴”。

“细微之处见真功”，真正能体现一个程序的功底恰恰在这些细微之处。

这就是程序员的——编程修养。

我总结了在用C/C++语言（主要是C语言）进行程序写作上

的三十二个“修养”，通过这些，你可以写出质量高的程序，同时也会让看你程序的人渍

渍称道，那些看过你程序的人一定会说：

“这个人的编程修养不错”。

     01、版权和版本

      02、缩进、空格、换行、空行、对齐

      03、程序注释

      04、函数的[in][out]参数

      05、对系统调用的返回进行判断

      06、if语句对出错的处理

      07、头文件中的#ifndef

      08、在堆上分配内存

      09、变量的初始化

      10、h和c文件的使用

      11、出错信息的处理

      12、常用函数和循环语句中的被计算量

      13、函数名和变量名的命名

      14、函数的传值和传指针

      15、修改别人程序的修养

      16、把相同或近乎相同的代码形成函数和宏

      17、表达式中的括号

      18、函数参数中的const

      19、函数的参数个数

      20、函数的返回类型，不要省略

      21、goto语句的使用

      22、宏的使用

      23、static的使用

      24、函数中的代码尺寸

      25、typedef的使用

      26、为常量声明宏

      27、不要为宏定义加分号

      28、||和&&的语句执行顺序

      29、尽量用for而不是while做循环

      30、请sizeof类型而不是变量

      31、不要忽略Warning

      32、书写Debug版和Release版的程序

1、版权和版本

好的程序员会给自己的每个函数，每个文件，都注上版权和版本。

对于C/C++的文件，文件头应该有类似这样的注释：

/************************************************************************

*

*  文件名：

network.c

*

*  文件描述：

网络通讯函数集

*

*  创建人：

HaoChen,2003年2月3日

*

*  版本号：

1.0

*

*  修改记录：

*

************************************************************************/

而对于函数来说，应该也有类似于这样的注释：

/*================================================================

*

*函数名：

XXX

*

*参  数：

*

*      typename[IN]:

descripts

*

*功能描述:

*

*      ..............

*

*返回值：

成功TRUE，失败FALSE

*

*抛出异常：

*

*作  者：

ChenHao2003/4/2

*

================================================================*/

这样的描述可以让人对一个函数，一个文件有一个总体的认识，对代码的易读性和易维护

性有很大的好处。

这是好的作品产生的开始。

2、缩进、空格、换行、空行、对齐

i）缩进应该是每个程序都会做的，只要学程序过程序就应该知道这个，但是我仍然看过不

缩进的程序，或是乱缩进的程序，如果你的公司还有写程序不缩进的程序员，请毫不犹豫

的开除他吧，并以破坏源码罪起诉他，还要他赔偿读过他程序的人的精神损失费。

缩进，

这是不成文规矩，我再重提一下吧，一个缩进一般是一个TAB键或是4个空格。

（最好用TA

B键）

ii）空格。

空格能给程序代来什么损失吗？

没有，有效的利用空格可以让你的程序读进来

更加赏心悦目。

而不一堆表达式挤在一起。

看看下面的代码：

  ha=（ha*128+*key++）%tabPtr->size;

  ha=（ha*128+*key++）%tabPtr->size;

  有空格和没有空格的感觉不一样吧。

一般来说，语句中要在各个操作符间加空格，函

数调用时，要以各个参数间加空格。

如下面这种加空格的和不加的：

if（（hProc=OpenProcess（PROCESS_ALL_ACCESS,FALSE,pid））==NULL）{

}

if（（hProc=OpenProcess（PROCESS_ALL_ACCESS,FALSE,pid））==NULL）{

}

iii）换行。

不要把语句都写在一行上，这样很不好。

如：

  for（i=0;i'9'）&&（a<'a'||a>'z'））break;

  我拷，这种即无空格，又无换行的程序在写什么啊？

加上空格和换行吧。

  for（i=0;i

      if（（a<'0'||a>'9'）&&

        （a<'a'||a>'z'））{

        break;

      }

  }

  好多了吧？

有时候，函数参数多的时候，最好也换行，如：

  CreateProcess（

            NULL,

            cmdbuf,

            NULL,

            NULL,

            bInhH,

            dwCrtFlags,

            envbuf,

            NULL,

            &siStartInfo,

            &prInfo

            ）;

  条件语句也应该在必要时换行：

  if（ch>='0'||ch<='9'||

      ch>='a'||ch<='z'||

      ch>='A'||ch<='Z'）

iv）空行。

不要不加空行，空行可以区分不同的程序块，程序块间，最好加上空行。

如：

  HANDLEhProcess;

  PROCESS_TprocInfo;

  /*opentheprocesshandle*/

  if（（hProcess=OpenProcess（PROCESS_ALL_ACCESS,FALSE,pid））==NULL）

  {

      returnLSE_MISC_SYS;

  }

  memset（&procInfo,0,sizeof（procInfo））;

  procInfo.idProc=pid;

  procInfo.hdProc=hProcess;

  procInfo.misc|=MSCAVA_PROC;

  return（0）;

v）对齐。

用TAB键对齐你的一些变量的声明或注释，一样会让你的程序好看一些。

如：

typedefstruct_pt_man_t_{

  int    numProc;  /*Numberofprocesses            */

  int    maxProc;  /*MaxNumberofprocesses        */

  int    numEvnt;  /*Numberofevents              */

  int    maxEvnt;  /*MaxNumberofevents          */

  HANDLE*pHndEvnt;  /*Arrayofevents              */

  DWORD  timeout;  /*Timeoutinterval            */

  HANDLE  hPipe;    /*Namedpipe                  */

  TCHAR  usr[MAXUSR];/*Usernameoftheprocess        */

  int    numMsg;    /*NumberofMessage            */

  int    Msg[MAXMSG];/*Spaceforintroprocesscommunicate*/

}PT_MAN_T;

怎么样？

感觉不错吧。

这里主要讲述了如果写出让人赏心悦目的代码，好看的代码会让人的心情愉快，读起代码

也就不累，工整、整洁的程序代码，通常更让人欢迎，也更让人称道。

现在的硬盘空间这

么大，不要让你的代码挤在一起，这样它们会抱怨你虐待它们的。

好了，用“缩进、空格

、换行、空行、对齐”装饰你的代码吧，让他们从没有秩序的土匪中变成一排排整齐有秩

序的正规部队吧。

3、程序注释

养成写程序注释的习惯，这是每个程序员所必须要做的工作。

我看过那种几千行，却居然

没有一行注释的程序。

这就如同在公路上驾车却没有路标一样。

用不了多久，连自己都不

知道自己的意图了，还要花上几倍的时间才看明白，这种浪费别人和自己的时间的人，是

最为可耻的人。

是的，你也许会说，你会写注释，真的吗？

注释的书写也能看出一个程序员的功底。

一般

来说你需要至少写这些地方的注释：

文件的注释、函数的注释、变量的注释、算法的注释

、功能块的程序注释。

主要就是记录你这段程序是干什么的？

你的意图是什么？

你这个变

量是用来做什么的？

等等。

不要以为注释好写，有一些算法是很难说或写出来的，只能意会，我承认有这种情况的时

候，但你也要写出来，正好可以训练一下自己的表达能力。

而表达能力正是那种闷头搞技

术的技术人员最缺的，你有再高的技术，如果你表达能力不行，你的技术将不能得到充分

的发挥。

因为，这是一个团队的时代。

好了，说几个注释的技术细节：

i）对于行注释（“//”）比块注释（“/**/”）要好的说法，我并不是很同意。

因为一

些老版本的C编译器并不支持行注释，所以为了你的程序的移植性，请你还是尽量使用块注

释。

ii）你也许会为块注释的不能嵌套而不爽，那么你可以用预编译来完成这个功能。

使用“

#if0”和“#endif”括起来的代码，将不被编译，而且还可以嵌套。

4、函数的[in][out]参数

我经常看到这样的程序：

FuncName（char*str）

{

  intlen=strlen（str）;

  .....

}

char*

GetUserName（structuser*pUser）

{

  returnpUser->name;

}

不！

请不要这样做。

你应该先判断一下传进来的那个指针是不是为空。

如果传进来的指针为空的话，那么，你

的一个大的系统就会因为这一个小的函数而崩溃。

一种更好的技术是使用断言（assert）

，这里我就不多说这些技术细节了。

当然，如果是在C++中，引用要比指针好得多，但你也

需要对各个参数进行检查。

写有参数的函数时，首要工作，就是要对传进来的所有参数进行合法性检查。

而对于传出

的参数也应该进行检查，这个动作当然应该在函数的外部，也就是说，调用完一个函数后

，应该对其传出的值进行检查。

当然，检查会浪费一点时间，但为了整个系统不至于出现“非法操作”或是“CoreDump”

的系统级的错误，多花这点时间还是很值得的。

5、对系统调用的返回进行判断

继续上一条，对于一些系统调用，比如打开文件，我经常看到，许多程序员对fopen返回的

指针不做任何判断，就直接使用了。

然后发现文件的内容怎么也读出不，或是怎么也写不

进去。

还是判断一下吧：

  fp=fopen（"log.txt","a"）;

  if（fp==NULL）{

      printf（"Error:

openfileerror\n"）;

      returnFALSE;

  }

其它还有许多啦，比如：

socket返回的socket号，malloc返回的内存。

请对这些系统调用

返回的东西进行判断。

6、if语句对出错的处理

我看见你说了，这有什么好说的。

还是先看一段程序代码吧。

  if（ch>='0'&&ch<='9'）{

      /*正常处理代码*/

  }else{

      /*输出错误信息*/

      printf（"error......\n"）;

      return（FALSE）;

  }

这种结构很不好，特别是如果“正常处理代码”很长时，对于这种情况，最好不要用else

。

先判断错误，如：

  if（ch<'0'||ch>'9'）{

      /*输出错误信息*/

      printf（"error......\n"）;

      return（FALSE）;

  }

 /*正常处理代码*/

  ......

这样的结构，不是很清楚吗？

突出了错误的条件，让别人在使用你的函数的时候，第一眼

就能看到不合法的条件，于是就会更下意识的避免。

7、头文件中的#ifndef

千万不要忽略了头件的中的#ifndef，这是一个很关键的东西。

比如你有两个C文件，这两

个C文件都include了同一个头文件。

而编译时，这两个C文件要一同编译成一个可运行文件

，于是问题来了，大量的声明冲突。

还是把头文件的内容都放在#ifndef和#endif中吧。

不管你的头文件会不会被多个文件引用

，你都要加上这个。

一般格式是这样的：

  #ifndef  <标识>

  #define<标识>

 ......

  ......

  #endif

<标识>在理论上来说可以是自由命名的，但每个头文件的这个“标识”都应该是唯一的。

标识的命名规则一般是头文件名全大写，前后加下划线，并把文件名中的“.”也变成下划

线，如：

stdio.h

  #ifndef_STDIO_H_

  #define_STDIO_H_

  ......

  #endif

（BTW：

预编译有多很有用的功能。

你会用预编译吗？

）  

8、在堆上分配内存

可能许多人对内存分配上的“栈stack”和“堆heap”还不是很明白。

包括一些科班出身

的人也不明白这两个概念。

我不想过多的说这两个东西。

简单的来讲，stack上分配的内存

系统自动释放，heap上分配的内存，系统不释放，哪怕程序退出，那一块内存还是在那里

。

stack一般是静态分配内存，heap上一般是动态分配内存。

由malloc系统函数分配的内存就是从堆上分配内存。

从堆上分配的内存一定要自己释放。

用free释放，不然就是术语——“内存泄露”（或是“内存漏洞”）——MemoryLeak。

于是，系统的可分配内存会随malloc越来越少，直到系统崩溃。

还是来看看“栈内存”和

“堆内存”的差别吧。

  栈内存分配

  char*

  AllocStrFromStack（）

  {

      charpstr[100];

      returnpstr;

  }

  堆内存分配

  char*

  AllocStrFromHeap（intlen）

  {

      char*pstr;

      if（len<=0）returnNULL;

      return（char*）malloc（len）;

  }

对于第一个函数，那块pstr的内存在函数返回时就被系统释放了。

于是所返回的char*什么

也没有。

而对于第二个函数，是从堆上分配内存，所以哪怕是程序退出时，也不释放，所

以第二个函数的返回的内存没有问题，可以被使用。

但一定要调用free释放，不然就是Me

moryLeak！

在堆上分配内存很容易造成内存泄漏，这是C/C++的最大的“克星”，如果你的程序要稳定

，那么就不要出现MemoryLeak。

所以，我还是要在这里千叮咛万嘱付，在使用malloc系统

函数（包括calloc，realloc）时千万要小心。

记得有一个UNIX上的服务应用程序，大约有几百的C文件编译而成，运行测试良好，等使用

时，每隔三个月系统就是down一次，搞得许多人焦头烂额，查不出问题所在。

只好，每隔

两个月人工手动重启系统一次。

出现这种问题就是MemeryLeak在做怪了，在C/C++中这种

问题总是会发生，所以你一定要小心。

一个Rational的检测工作——Purify，可以帮你测

试你的程序有没有内存泄漏。

我保证，做过许多C/C++的工程的程序员，都会对malloc或是new有些感冒。

当你什么时候

在使用malloc和new时，有一种轻度的紧张和惶恐的感觉时，你就具备了这方面的修养了。

对于malloc和free的操作有以下规则：

1）配对使用，有一个malloc，就应该有一个free。

（C++中对应为new和delete）

2）尽量在同一层上使用，不要像上面那种，malloc在函数中，而free在函数外。

最好在同

一调用层上使用这两个函数。

3）malloc分配的内存一定要初始化。

free后的指针一定要设置为NULL。

注：

虽然现在的操作系统（如：

UNIX和Win2k/NT）都有进程内存跟踪机制，也就是如果你

有没有释放的内存，操作系统会帮你释放。

但操作系统依然不会释放你程序中所有产生了

MemoryLeak的内存，所以，最好还是你自己来做这个工作。

（有的时候不知不觉就出现M

emoryLeak了，而且在几百万行的代码中找无异于海底捞针，Rational有一个工具叫Puri

fy，可能很好的帮你检查程序中的MemoryLeak）

9、变量的初始化

接上一条，变量一定要被初始化再使用。

C/C++编译器在这个方面不会像JAVA一样帮你初始

化，这一切都需要你自己来，如果你使用了没有初始化的变量，结果未知。

好的程序员从

来都会在使用变量前初始化变量的。

如：

  1）对malloc分配的内存进行memset清零操作。

（可以使用calloc分配一块全零的内存

）

  2）对一些栈上分配的struct或数组进行初始化。

（最好也是清零）

不过话又说回来了，初始化也会造成系统运行时间有一定的开销，所以，也不要对所有的

变量做初始化，这个也没有意义。

好的程序员知道哪些变量需要初始化，哪些则不需要。

如：

以下这种情况，则不需要。

      char*pstr;  /*一个字符串*/

      pstr=（char*）malloc（50）;

      if（pstr==NULL）exit（0）;

      strcpy（pstr,"HelloWrold"）;

但如果是下面一种情况，最好进行内存初始化。

（指针是一个危险的东西，一定要初始化

）

      char**pstr;  /*一个字符串数组*/

      pstr=（char**）malloc（50）;

      if（pstr==NULL）exit（0）;

      /*让数组中的指针都指向NULL*/

      memset（pstr,0,50*sizeof（char*））;

而对于全局变量，和静态变量，一定要声明时就初始化。

因为你不知道它第一次会