分析一套源代码的代码规范和风格并讨论如何改进优化代码

我的工程实践项目是在网站上面展示不同传感器的特性,也就是说,它的核心功能是信息展示。我找到了一套使用ssm框架搭建的信息管理系统,下面是它的源代码目录结构

 

分析一套源代码的代码规范和风格并讨论如何改进优化代码_第1张图片

 

 展开之后是下面这样的,目录合理清晰,根据功能分成了很多不同的模块,拆分成不同的文件,有利于后面进行修改更新。

 

 

分析一套源代码的代码规范和风格并讨论如何改进优化代码_第2张图片

 

 部分代码如下:

分析一套源代码的代码规范和风格并讨论如何改进优化代码_第3张图片

 

 代码风格总体来说还是比较易读的,该有的注释也都写清楚了,命名很规范。

 

同类编程语言或项目在代码规范和风格的一般要求如下:

1:命名要展示对象的功能。文件名一定要能传达文件的内容信息,别人一看到文件名就是知道文件中放的是什么内容。只把一个类或者一类的代码放在一起是好的习惯,这样就很容易给文件取 一个直观的名字。业余爱好者常常把很多没关系的代码糅到一个文件中,结果造成代码杂乱无章,也很难给它取一个恰当的名字。

2:函数名:单词小写,多个单词用下划线分隔。 
如:find_node 
注意:同样,一个函数只完成单一功能,不要用代码的长度来衡量是不是要把一段代码独立 成一个函数。即使只有几行代码,只要它完成的是一项独立的功 能,都应该提为一个单独的函数,而函数名可以直观的反应出它的功能。如果在给函数起名时遇到了困难,通常是函 数设计不合理,应该仔细思考一下。

3:宏名:单词大写,多个单词下划线分隔 
如:#define MAX_PATH 260

4:变量名:单词小写,多个单词下划线分隔。 

5:合理使用空行

函数体之间用空行分隔。 
结构/联合/枚举声明空行分隔。 
不同功能的代码块之间用空行分隔。 
类似的代码放在一起,和其它部分用空行分隔。比如宏定义,类型定义,函数声明和全局变量放在一起。 
使用空行时,一行就够了,不要使用连续多个空行,那样让人感觉空荡荡。

等号两边用空格。如: 

如:int a = 100; 
参数之间用空格。如: 
如:test(int a, int b, int c) 
语句末的分号与前面内容不要加空格。 
如:test(a, b, c); 

6:合理使用括号

用括号分隔子表达式,不要只靠默认优先级来判断。 
如:((a && b) || (c && d)) 
用括号分隔if/while/for等语句的代码块,那怕代码只有一行。 
如:

  1.  
    if(a > b)
  2.  
    {
    1.   
    2. return c;
     
    }

 

 

你可能感兴趣的:(分析一套源代码的代码规范和风格并讨论如何改进优化代码)