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

Posted 2020-11-15 jingjd

　　我的工程实践主要是通过python语言来完成，所以接下来围绕着python语言以及一套相关源代码来展开代码规范与风格的讨论

                                       　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　 （源于网络）

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

　　命名规范

　 模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)

　 类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头

　 函数名一律小写，如有多个单词，用下划线隔开

　 变量名尽量小写, 如有多个单词，用下划线隔开

　 常量使用以下划线分隔的大写命名

 

　　如无特殊情况, 文件一律使用 UTF-8 编码 

　　如无特殊情况, 文件头部必须加入#--coding:utf-8--标识

　　import语句应该放在文件头部，置于模块说明及docstring之后，于全局变量之前；

　　引号，自然语言使用双引号，机器标示使用单引号，因此 代码里 多数应该使用 单引号 

 

　　在二元运算符两边各空一格[=,-,+=,==,>,in,is not, and]:

 

 

 

 

　　docstring 的规范中最其本的两点：
　　所有的公共模块、函数、类、方法，都应该写 docstring 。私有方法不一定需要，但应该在 def 后提供一个块注释来说明。
docstring 的结束"""应该独占一行，除非此 docstring 只有一行。

 

 

 

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

 

　　每行代码尽量不超过 80 个字符(在特殊情况下可以略微超过 80 ，但最长不得超过 120) 方便在控制台下查看代码 

 

 

 　　Python 支持括号内的换行。这时有两种情况。

　　1) 第二行缩进到括号的起始处

　　　　foo = long_function_name(var_one, var_two,
　　　　                         var_three, var_four)
　　2) 第二行缩进 4 个空格，适用于起始括号就换行的情形

　　　　def long_function_name(
　　　　        var_one, var_two, var_three,
　　　　        var_four):

 

　　关于README的内容

　　这个我觉得是每个项目都应该有的一个文件，目的是能简要描述该项目的信息，让读者快速了解这个项目。

它需要说明以下几个事项:

1. 软件定位，软件的基本功能。
2. 运行代码的方法: 安装环境、启动命令等。
3. 简要的使用说明。
4. 代码目录结构说明，更详细点可以说明软件的基本原理。
5. 常见问题说明。