分析一套源代码的代码规范和风格并讨论如何改进优化代码
Posted dhy970218
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了分析一套源代码的代码规范和风格并讨论如何改进优化代码相关的知识,希望对你有一定的参考价值。
一.结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构,文件名、类名,函数名,变量名等命名,接口定义规范等方面的做法和特点:
从以下目录结构可见,该源代码结构清晰
以下面这段代码为例来分析该源码在文件名,类名,函数名以及变量名等命名方面的规范特点:
- 包命名规范符合要求,包名采用后缀倒置加上自定义,采用小写字母。
- 类名和接口定义符合规范,使用每个英文单词首字母大写的大小写混合命名法。
- 方法名命名符合命名规范,java中,方法名的第一个单词首字母用小写,剩余单词使用首字母大写其余字母小写的大小写混合法。
- 属性名命名符合规范,与方法名命名规范类似,即第一个单词小写剩余单词大小写混合,另外需要注意的是属性名不能与方法名相同。
- 常量命名规范,使用全大写英文,单词之间使用下划线分隔开。
二.列举哪些做法符合代码规范和风格一般要求:
1.该源码的文件名,类名,函数名,变量名等等的定义都符合规划要求。
2.代码之间的空行,每段代码前面的缩进都有利于增加源码的易读性。
3.在相应的代码旁边做有注释有利于后期维护与更新。
三.同类编程语言在代码规范和风格上的一般要求:
1.类名首字母要大写,字段,方法和对象的首字母应该小写,对于所有标识符,其中所包含的单词都应紧靠在一起,
2.将方法设计成简要的功能性单元,方法要简明扼要。
3.要尽可能多加注释,提高可读性。
4.尽量使用interfaces,不要使用abstract类。
5.花括号的使用要遵循 K&R 风格。
6.对于自己创建的每一个类,都要加入一个main函数来测试那个类的代码。
。。。。。。
以上是关于分析一套源代码的代码规范和风格并讨论如何改进优化代码的主要内容,如果未能解决你的问题,请参考以下文章