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

     工程实践选题为室内定位与导航,因此选择了一个包含数据采集、WiFi+PDR定位、路径规划等功能的室内定位服务程序进行代码规范和风格等的分析。

1、源代码目录结构和文件名

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

(1)src文件:项目的主要代码和资源所在。

(2)androidTest文件:用来编写Android Test测试用例,可以对项目进行一些自动化测试。

(3) main文件:存放所有Java代码,可以构建子目录来规范管理代码。

(4) res文件:几乎是所有的资源都存放在这里,每个文件夹都有自己的功用。比如drawable内存放图片文件,layout为所有的布局xml文件。

(5) AndroidManifest.xml文件:当前Android项目的配置文件,程序中定义的四大组件都在其中进行注册,以及程序的权限声明。

(6) test文件:用来编写Unit Test测试用例。

2、函数名和变量名

变量命名和方法命名要遵循首字母小写原则,如果名称是由多个单词组成,每个单词的首字母都要大写(除首个单词),并做到尽量简短且能清楚的表达变量的作用,做到见名知意。本项目中相关函数和变量的命名规则上基本符合要求。

public void onLocationChanged(Location location) { }

public void onProviderEnabled(String provider) { }

public void onStatusChanged(String provider, int status, Bundle extras) { }

boolean isGPSEnabled = false;

boolean isNetworkEnabled = false;

boolean canGetLocation = false;

3、接口定义规范和单元测试组织

各个 test文件中的测试用例文件ExampleUnitTest.java都写了如何进行相关的单元测试,并且在androidTest文件中也有一些测试用例,可以对项目进行一些自动化测试。

4、列举哪些做法有悖于“代码的简洁、清晰、无歧义”的基本原则,及如何进一步优化改进

关于注释的问题,本项目中注释并不完善,代码中的注释应包括:

(1)类的目的(即类所完成的功能)、设置接口的目的以及应如何被使用。

(2) 成员方法(对于设置与获取成员方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成的功能、参数的含义以及返回值)。

(3)普通成员方法内部注释(控制结构、代码做了些什么以及为什么这样做,处理顺序等)注释哪些部分, 实参和形参的含义以及其他任何约束或前提条件、字段或属性描述。

5、总结同类编程语言或项目在代码规范和风格的一般要求

(1)缩进:程序块要采用缩进风格编写,缩进要使用TAB键,不要使用空格键(编辑器中请将TAB设置为4格);方法体的开始、类的定义、以及if、for、do、while、switch、case语句中的代码都要采用缩进方式。

(2)对齐:程序块的分界符左大括号和右大括号都要另起一行,并且要位于同一列,还要与引用它们的语句左对齐;同样对齐时只使用TAB键,而不使用空格键;不要把多个短语句写在一行中。

(3)间隔

1)类、方法及相对独立的程序块之间、变量说明之后必须加空行;关键字之后要留空格;

2)二元操作符如   " ="、" +="  " >="、" <="、" +"、" *"、" %"、" &&"、" ||"、" <<" ," ^" 等的前后应当加空格;

3)一元操作符如" !"、" ~"、" ++"、" --"等前后不加空格;xiang"[ ]"、" ." 这类操作符前后不加空格;

4)for语句中的表达式应该被空格分开;强制转型后应该跟一个空格。

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