分析一套源代码源代码的代码规范和风格并讨论如何改进优化代码
1.结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的做法和特点;
本次分析的源代码是《Android仓库管理系统》项目的源代码,该项目实现了包括出库,入库,订单,盘点,拣货等功能,可以进行一维码扫描,二维码扫描,摄像头扫描,自定义控件,网络通讯,sqllite数据库使用
该项目的目录结构:
这其中java文件夹中是实现各活动功能的代码,res文件夹中是布局文件,各文件都以具体每个活动实现的功能命名,可以很轻松地找到相应界面。
2.列举哪些做法符合代码规范和风格一般要求:
该项目是用JAVA进行的编程,活动函数名都十分规范,部分代码如下:
可以看到,它格式规范,没有多少冗余语句,但是缺少注释,这对代码的阅读带来了很多麻烦
3.列举哪些做法有悖于“代码的简洁、清晰、无歧义”的基本原则,及如何进一步优化改进;
总体来看这个项目的代码还是足够简洁的,但是因为缺少注释导致阅读代码需要多花费很多时间,不够清晰,应当多添加注释,不管是对于第三方还是自己的编码优化都有很大的好处。
4.总结同类编程语言或项目在代码规范和风格的一般要求。
安卓开发普遍使用的都是JAVA语言,在编程时需要注意到:
1、首先在每个.java文件的开始需要注释标明编码的时间作者以及文件功能。
2、每个文件和变量的命名都要有实际意义,可以表明这个文件和变量的功能用途。
3、需要严格按照Java代码的书写规范,注意缩进格式统一等问题使得代码看上去简洁整齐。
4、每段关键代码都需要写好注释,增加代码可读性。