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

我的工程实践项目是少儿编程网站的开发。从github上找的项目为用maven管理的SSM框架开发的一个少儿编程网站的项目。

源代码目录结构

 

除了main目录下存在不必要的目录,其他的目录均为SSM框架开发的标准的web项目。

文件名、包名均为小写,类名使用驼峰式大写,方法名、局部变量首个单词小写,后续每个单词首字母大写,常量名全大写并且单词之间使用下划线分开。

对于单元测试通过Junit类加Test注释来完成单元测试。

1、列举哪些做法符合代码规范和风格一般要求;

     对src文件下的目录符合SSM开发软件的规范,按照spring当中的层次将不同层次功能的类放在对应文件夹下。

    文件名,类名,包名,局部变量以及常量名均符合Java开发中的规范。且注释描述详细得当。

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

    在main文件夹下存在冗余的文件夹,xml文件配置中注释很少。

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

    驼峰式命名法(CamelCase):驼峰式命名法分大驼峰式命名法(UpperCamelCase)和小驼峰式命名法(lowerCamelCase)。

    标识符类型的规则:①包名全部小写,连续的单词只是简单地连接起来,不使用下划线。②类名通常是名词或名词短语,接口名称有时可能是形容词或形容词短语。 类名都以UpperCamelCase风格编写。③方法名通常是动词或动词短语。方法名都以lowerCamelCase风格编写。④每个常量都是一个静态final字段,但不是所  有静态final字段都是常量。常量名命名模式全部字母大写,用下划线分隔单词。⑤非常量字段名以lowerCamelCase风格编写。⑥参数名以lowerCamelCase风格编写。 ⑦局部变量名以lowerCamelCase风格编写。⑧类型变量可用以下两种风格之一进行命名:单个的大写字母,后面可以跟一个数字(如:E, T, X, T2)。•以类命名方式后面加个大写的T(如:RequestT, FooBarT)。

 源文件结构顺序为:
    1.package语句
    2.import语句:①不要换行;②顺序和间距:import语句可分为以下几组,按照这个顺序,每组由一个空行分隔:
    A、所有的静态导入独立成组
    B、com.google imports(仅当这个源文件是在com.google包下)
    C、第三方的包。每个顶级包为一组,字典序。例如:android, com, junit, org, sun
    D、java imports
    E、javax imports
    组内不空行。

原文地址:https://www.cnblogs.com/tlxclmm/p/11636628.html