编码规范

来源:互联网 发布:国家安全法 网络窃密 编辑:程序博客网 时间:2024/04/30 01:27
1.4.B 编码规范——如何写出简洁优美的代码 
  
下面是来自两位C语言程序员的实现相同功能的两段代码: 
  
l 月薪1000元的程序员的代码: 
  
#include <stdio.h> 
int main() 

     FILE *Wenjian; char Str[100]; 
     Wenjian = fopen("test.txt","w"); 
     do { 
     gets(Str); 
     if(Str[0] == '!') 
             break; fputs(Str,Wenjian);  }while(1); 
     fclose(Wenjian); 
     return 0; 

  
l 月薪10000元的程序员的代码: 
  
#include <stdio.h> 
int main() 

     // 文件指针和保存输入的字符串 
     FILE *fp = NULL; 
     char str[100] = ""; 
     // 以可写方式打开文件 
     if(NULL==(fp = fopen("test.txt","w"))) 
     { 
         printf("cannot open the file.\n"); 
         return 1; 
     } 
     // 提示用户输入 
     printf("please input a string:\n"); 
     do 
     { 
         // 判断输入是否结束 
         gets(str); 
         if('!' == str[0]) 
             break; 
         // 写入文件 
         fputs(str,fp); 
     }while(1); 
     // 关闭文件 
     if(NULL!=fp) 
         fclose(fp); 
     fp = NULL; 
     return 0; 

  
其实,不用我多说,两位程序员的工资,已经很明显地说明了这两段代码孰优孰劣。那位月薪1000元的程序员的代码,有着大多数初学者编写代码时的坏习惯:变量名大小写混用、中英文混用(这大约是中国程序员的一大特点);同一行代码定义多个不相关变量;定义变量而不进行必要的初始化;对文件打开等可能出错的操作不进行防错处理;缺少必要的程序提示;“==”比较中变量在前常量在后;程序中只有代码没有注释;各种语句没有经过较规范的排版、代码版式错乱无章、无规则的代码缩进等等。 
  
第一段代码集中地反映了初学者在开始学习编写程序的时候,因为没有接触良好的编码规范而形成的混乱的编码习惯,使得自己写出来的代码“惨不忍睹”,没有任何的可读性和可维护性。虽然编译器并不在意你编写的代码是否美观,但是,我们应该记住,除了编译器之外,我们的代码也是写给别人看的。如果不想让别人在维护你的代码时骂娘的话,如果不想让你的工资始终停留在1000元上下的话,就要好好学习一下编码规范,向月薪10000元的程序员看齐。