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

Posted 2021-03-26 lcw12356

1.结合工程实践选题相关的一套源代码，根据其编程语言或项目特点，分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的做法和特点

目录结构如下

 

 

 

2.列举哪些做法符合代码规范和风格一般要求

1.无论是在“空行”还是在“空格”，都使该开源项目设计的非常易读，代码更清晰；

2.该项目的命名格式遵从帕斯卡命名法，而且名称本身就具有含义，增加了代码的可读性；

3.该项目的缩进严格按照要求，使整体代码更加美观；

 

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

本代码的注释过少，会导致阅读本代码的阅读体验变差。

 

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

Python语言规范

　　1. imports 仅仅用做包和模块的导入，包的导入每个尽量独占一行

　　2. packages 导入模块尽量使用模块的全路径

　　3. Exceptions 必须小心使用

　　4. Global variables 避免使用全局变量

　　5. Generator 

　　6. lambda 函数仅仅适用于一行代码能实现的简单函数

　　7. True or False 尽量使用[],‘‘,{},0,None来隐式表示False

Python风格规范　

　　1、代码编排

　　　　1 缩进：4个空格实现缩进，尽量不使用Tab，禁止混用Tab和空格

　　　　2 行：每行最大长度不超过79，换行可以使用反斜杠()。最好使用圆括号将换行内容括起来，不建议使用“;”

　　　　3 空行：类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

　　　　4 空格：括号内的第一个位置，不要空格。紧靠右括号的位置也不要空格。冒号(:)、逗号(,)、分号(;)之前不要加空格。切片木有参数，不要加空格等

　　　　5 括号：对于单元素tuple一定要加,和括号

　　2、命名规范

　　　　module_name

　　　　package_name  

　　　　ClassName  

　　　　method_name  

　　　　ExceptionName

　　　　function_name

　　　　GLOBAL_CONSTANT_NAME

　　　　global_var_name

　　　　instance_var_name

　　　　function_parameter_name

　　　　local_var_name

　　3、注释规范

　　　　

　　　　1.块注释，在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如：

　　　　# Description : Module config. 　　　　# 　　　　# Input : None 　　　　# 　　　　# Output : None

　　　　2. 行注释，在一句代码后加注释。比如：x = x + 1 # Increment x 但是这种方式尽量少使用。

　　　　3. 避免无谓的注释。

　　4、编程建议

　　　　1. 字符串拼接，尽量使用join。使用str的方法而不是内置方法。使用startswith或endswith拉检查前缀和后缀

　　　　2. 单例对象，尽量使用is 、is not，不要使用==

　　　　3. 使用is not而不是not is

　　　　4. 使用def来定义函数，而不是将匿名函数赋给某个变量

　　　　5. 尽量使代码整齐，简洁

　　　　6. 使用isinstance()来判断instance的类型