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

一.结合工程实践选题相关的一套源代码,根据其编程语言或项目特色,分析其在源代码目录结构,文件名、类名,函数名,变量名等命名,接口定义规范等方面的作法和特色:java

从如下目录结构可见,该源代码结构清晰编程

    

如下面这段代码为例来分析该源码在文件名,类名,函数名以及变量名等命名方面的规范特色:编程语言

 

  1. 包命名规范符合要求,包名采用后缀倒置加上自定义,采用小写字母。
  2. 类名和接口定义符合规范,使用每一个英文单词首字母大写的大小写混合命名法。
  3. 方法名命名符合命名规范,java中,方法名的第一个单词首字母用小写,剩余单词使用首字母大写其他字母小写的大小写混合法。
  4. 属性名命名符合规范,与方法名命名规范相似,即第一个单词小写剩余单词大小写混合,另外须要注意的是属性名不能与方法名相同。
  5. 常量命名规范,使用全大写英文,单词之间使用下划线分隔开。

二.列举哪些作法符合代码规范和风格通常要求:函数

        1.该源码的文件名,类名,函数名,变量名等等的定义都符合规划要求。测试

        2.代码之间的空行,每段代码前面的缩进都有利于增长源码的易读性。设计

        3.在相应的代码旁边作有注释有利于后期维护与更新。3d

三.同类编程语言在代码规范和风格上的通常要求:代码规范

        1.类名首字母要大写,字段,方法和对象的首字母应该小写,对于全部标识符,其中所包含的单词都应紧靠在一块儿,对象

        2.将方法设计成简要的功能性单元,方法要简明扼要。blog

        3.要尽量多加注释,提升可读性。

        4.尽可能使用interfaces,不要使用abstract类。

        5.花括号的使用要遵循 K&R 风格。

        6.对于本身建立的每个类,都要加入一个main函数来测试那个类的代码。

        。。。。。。

相关文章
相关标签/搜索