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

      我的工程实践课题是《智能化仓储管理平台》,我从github上找到了一个相关的项目代码。这个项目名称叫做《基于SSM的前后端分离的仓储管理系统》,该项目实现了包括出库,入库,订单,盘点,拣货等功能。

      该项目在github上的具体框架如图:分析一套源代码的代码规范和风格并讨论如何改进优化代码_第1张图片

 

         该项目在后端主要应用了Spring+SpringMVC+MyBatis,缓存使用了Redis,并使用了Spring Cache的缓存注解,可以直接应用到方法上。在前端使用了阿里巴巴开源的lceworks构建。具体代码框架是这样的分析一套源代码的代码规范和风格并讨论如何改进优化代码_第2张图片

 

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

 

         可以看到这段代码格式规范,简练,还加了注释方便他人阅读。

 

         总结同类编程语言或项目在代码规范和风格的一般要求:好的编程风格固然重要,但是你一定听说过一些程序员的个人风格。其实我们完全不必为那些所谓条条框框所累,但是作为原则是我们至少不能打破这些常规。我们应该在保持自己风格的同时尽量的把自己与编程潜原则靠拢。

可读性很容易达到,比如,让自己的代码缩排排列、名字采用描述性但不要过长(短名应仅仅用在非远程)、特殊名称比如pi应当被定义为final类型。模块性是编程需要注意的另一重点,把代码划分到类里,在类中把功能划分到方法中,别让一个类太大,否则在使用、修改和理解上都会造成不必要的麻烦,方法也一样,如果一个方法长度超过50行,它产生错误的概率将接近100%,尽量把大方法划分为小方法,编程中为避免重复编写,还应尽量调用JAVA标准类库。

尽量避免在写代码和注释时使用不同语言,经常见到论坛有朋友询问诸如在java中调用c、调用php、调用shell之类的问题,其实在编程中,我们应尽量使用一种语言去完成事情。另外就是不必最优化自己的代码,应该选择相对较优的算法就可以了。

 

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