编程修养(二)

原创 2003年05月08日 12:12:00

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

对于C/C++的文件,文件头应该有类似这样的注释:
/************************************************************************
*
*   文件名:network.c
*
*   文件描述:网络通讯函数集
*
*   创建人: Hao Chen, 2003年2月3日
*
*   版本号:1.0
*
*   修改记录:
*
************************************************************************/

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

/*================================================================
 *
 * 函 数 名:XXX
 *
 * 参    数:
 *
 *        type name [IN] : descripts
 *
 * 功能描述:
 *
 *        ..............
 *
 * 返 回 值:成功TRUE,失败FALSE
 *
 * 抛出异常:
 *
 * 作    者:ChenHao 2003/4/2
 *
 ================================================================*/

这样的描述可以让人对一个函数,一个文件有一个总体的认识,对代码的易读性和易维护性有很大的好处。这是好的作品产生的开始。

 

2、缩进、空格、换行、空行、对齐
————————————————
i) 缩进应该是每个程序都会做的,只要学程序过程序就应该知道这个,但是我仍然看过不缩进的程序,或是乱缩进的程序,如果你的公司还有写程序不缩进的程序员,请毫不犹豫的开除他吧,并以破坏源码罪起诉他,还要他赔偿读过他程序的人的精神损失费。缩进,这是不成文规矩,我再重提一下吧,一个缩进一般是一个TAB键或是4个空格。(最好用4个空格)<--由网友vector_3d提醒改正

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<len;i++) if((a[i]<'0'||a[i]>'9')&&(a[i]<'a'||a[i]>'z')) break;
   
    我拷,这种即无空格,又无换行的程序在写什么啊?加上空格和换行吧。   
   
    for ( i=0; i<len; i++) {
        if ( ( a[i] < '0' || a[i] > '9' ) &&
             ( a[i] < 'a' || a[i] > '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) 空行。不要不加空行,空行可以区分不同的程序块,程序块间,最好加上空行。如:

    HANDLE hProcess;
    PROCESS_T procInfo;

    /* open the process handle */
    if((hProcess = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid)) == NULL)
    {
        return LSE_MISC_SYS;
    }

    memset(&procInfo, 0, sizeof(procInfo));
    procInfo.idProc = pid;
    procInfo.hdProc = hProcess;
    procInfo.misc |= MSCAVA_PROC;

    return(0);
                 
v) 对齐。用TAB键对齐你的一些变量的声明或注释,一样会让你的程序好看一些。如:

typedef struct _pt_man_t_ {
    int     numProc;    /* Number of processes                 */
    int     maxProc;    /* Max Number of processes             */
    int     numEvnt;    /* Number of events                    */
    int     maxEvnt;    /* Max Number of events                */
    HANDLE* pHndEvnt;   /* Array of events                     */
    DWORD   timeout;    /* Time out interval                   */
    HANDLE  hPipe;      /* Namedpipe                           */
    TCHAR   usr[MAXUSR];/* User name of the process            */
    int     numMsg;     /* Number of Message                   */
    int     Msg[MAXMSG];/* Space for intro process communicate */
} PT_MAN_T;

怎么样?感觉不错吧。

这里主要讲述了如果写出让人赏心悦目的代码,好看的代码会让人的心情愉快,读起代码也就不累,工整、整洁的程序代码,通常更让人欢迎,也更让人称道。现在的硬盘空间这么大,不要让你的代码挤在一起,这样它们会抱怨你虐待它们的。好了,用“缩进、空格、换行、空行、对齐”装饰你的代码吧,让他们从没有秩序的土匪中变成一排排整齐有秩序的正规部队吧。


                 

3、程序注释
——————
养成写程序注释的习惯,这是每个程序员所必须要做的工作。我看过那种几千行,却居然没有一行注释的程序。这就如同在公路上驾车却没有路标一样。用不了多久,连自己都不知道自己的意图了,还要花上几倍的时间才看明白,这种浪费别人和自己的时间的人,是最为可耻的人。

是的,你也许会说,你会写注释,真的吗?注释的书写也能看出一个程序员的功底。一般来说你需要至少写这些地方的注释:文件的注释、函数的注释、变量的注释、算法的注释、功能块的程序注释。主要就是记录你这段程序是干什么的?你的意图是什么?你这个变量是用来做什么的?等等。

不要以为注释好写,有一些算法是很难说或写出来的,只能意会,我承认有这种情况的时候,但你也要写出来,正好可以训练一下自己的表达能力。而表达能力正是那种闷头搞技术的技术人员最缺的,你有再高的技术,如果你表达能力不行,你的技术将不能得到充分的发挥。因为,这是一个团队的时代。

好了,说几个注释的技术细节:

i) 对于行注释(“//”)比块注释(“/* */”)要好的说法,我并不是很同意。因为一些老版本的C编译器并不支持行注释,所以为了你的程序的移植性,请你还是尽量使用块注释。

ii) 你也许会为块注释的不能嵌套而不爽,那么你可以用预编译来完成这个功能。使用“#if 0”和“#endif”括起来的代码,将不被编译,而且还可以嵌套。

 


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

我经常看到这样的程序:
FuncName(char* str)
{
    int len = strlen(str);
    .....
}

char*
GetUserName(struct user* pUser)
{
    return pUser->name;
}

不!请不要这样做。

你应该先判断一下传进来的那个指针是不是为空。如果传进来的指针为空的话,那么,你的一个大的系统就会因为这一个小的函数而崩溃。一种更好的技术是使用断言(assert),这里我就不多说这些技术细节了。当然,如果是在C++中,引用要比指针好得多,但你也需要对各个参数进行检查。

写有参数的函数时,首要工作,就是要对传进来的所有参数进行合法性检查。而对于传出的参数也应该进行检查,这个动作当然应该在函数的外部,也就是说,调用完一个函数后,应该对其传出的值进行检查。

当然,检查会浪费一点时间,但为了整个系统不至于出现“非法操作”或是“Core Dump”的系统级的错误,多花这点时间还是很值得的。

 


5、对系统调用的返回进行判断
——————————————
继续上一条,对于一些系统调用,比如打开文件,我经常看到,许多程序员对fopen返回的指针不做任何判断,就直接使用了。然后发现文件的内容怎么也读出不,或是怎么也写不进去。还是判断一下吧:

    fp = fopen("log.txt", "a");
    if ( fp == NULL ){
        printf("Error: open file error/n");
        return FALSE;
    }

其它还有许多啦,比如:socket返回的socket号,malloc返回的内存。请对这些系统调用返回的东西进行判断。

<-上一页  下一页->

(版权所有,转载时请注明出处和作者信息)

 

编程修养——陈皓

什么是好的程序员?是不是懂得很多技术细节?还是懂底层编程?还是编程速度比较快? 我觉得都不是。对于一些技术细节来说和底层的技术,只要看帮助,查资料就能找到,对 于速度快,只要编得多也就熟能生巧...
  • w616589292
  • w616589292
  • 2014年10月30日 19:35
  • 276

程序员的自我修养——读书笔记

第一部分:温故而知新 第一章:介绍基本的背景知识——操作系统、线程、硬件1、关于C语言中的hello world这些问题你都清楚吗? 2、计算机硬件设备的三个核心部件: 1》中央处...
  • lemonwxj
  • lemonwxj
  • 2016年05月11日 11:52
  • 637

编程修养(二)

本文转自:http://blog.csdn.net/haoel/article/details/2873 1、版权和版本 ——————— 好的程序员会给自己的每个函数,每个文件,都注上版权和版本。...
  • danshiming
  • danshiming
  • 2017年01月09日 18:42
  • 103

编程修养(二)

1、版权和版本 ——————— 好的程序员会给自己的每个函数,每个文件,都注上版权和版本。 对于C/C++的文件,文件头应该有类似这样的注释: /*********************...
  • nuptwanglei
  • nuptwanglei
  • 2015年08月01日 15:38
  • 160

程序员的自我修养读书笔记

1.进程直接使用物理内存的坏处:第一、地址空间不隔离,一个进程可能改写另一个进程的数据,从而导致系统崩溃。第二、内存使用效率低,频繁的数据换入换出,效率低。第三、程序运行地址不稳定,每次重新装载的空闲...
  • Deep_l_zh
  • Deep_l_zh
  • 2016年06月26日 19:45
  • 2523

编程修养(二)

1、版权和版本 ——————— 好的程序员会给自己的每个函数,每个文件,都注上版权和版本。 对于C/C++的文件,文件头应该有类似这样的注释: /**************************...
  • u010027547
  • u010027547
  • 2016年01月13日 15:28
  • 153

程序员的自我修养(1)——操作系统篇

本文是“程序员的自我修养”系列文章第一篇。介绍程序员都应该知道的操作系统知识!即是面试必备,更是程序员的自我修养! 也许,只需这一篇文章,便能让你全面的认识操作系统! 在阅读本文之前,推荐...
  • wxx634897019
  • wxx634897019
  • 2014年08月29日 09:38
  • 1368

程序员的自我修养-----Java开发的必须知道的几个注意点

1. 将一些需要变动的配置写在属性文件中 比如,没有把一些需要并发执行时使用的线程数设置成可在属性文件中配置。那么你的程序无论在DEV环境中,还是TEST环境中,都可以顺畅无阻地运行,但是一旦部署...
  • duruiqi_fx
  • duruiqi_fx
  • 2016年07月22日 14:52
  • 8904

《程序员的自我修养—链接、装载与库》

《程序员的自我修养—链接、装载与库》 ——读书笔记 2013年11月18日 2.1 被隐藏了的过程 预编译(cpp or gcc -E)-> 编译(cc1包含了预编译 or gcc -...
  • HuiyuYang_fish
  • HuiyuYang_fish
  • 2013年11月18日 19:22
  • 2854

读《程序员自我修养》 总结

技术上 尽早编码统一命名习惯不要提前优化清楚地思考,清除地表达:隔离辅助代码,让程序变得易读;抽象部分逻辑,让程序简单明了 看看开源项目Apache HTTP Server 或者 FreeBSD,想...
  • cylj102908
  • cylj102908
  • 2016年03月21日 17:12
  • 265
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:编程修养(二)
举报原因:
原因补充:

(最多只允许输入30个字)