自定义函数代码的规范

1、规范

a、时间充足的情况下，函数注释写上去

b、测试用例选择，随机加特殊实例

c、代码尽量不要多出出现同一意思的原始数字或字符串

d、diamante中尽量不要多重循环判断（if）或多重循环遍历（for）

e、一定要封装成函数或类

f、工具库或方法的内部实现中最好不要有print 或日志

g、返回值不要返回字符串

 

 

2、例如：

a、文件开头标明编码（文件中有中文的代码，要注明 utf-8 ，防止他人复制时，出现问题，可能就是编码问题）

 

 

b、函数中多次使用的常量，使用变量赋值来命名（如果是全局使用变量放在函数外，局部变量放函数里面）：常量更加方便使用，同时相比复杂的常量，不容易出错，出错也会报错提示，而常量出错，不便排错

 

 

 

c、函数命名要规范，要通俗易懂，最好能一看就能看出这个函数的作用

 

 

d、函数注释规范：函数作用，函数传参类型、传的什么参，输出类型，输出什么（最好从注释一眼看出函数作用及传参、输出相关类型）

 

 

 

 

c、if 或 for 不要出现多重嵌套（最好不要出现三重嵌套），可维护性差、阅读差

 

 

f、函数中最好不要返回中文（英文也少用，也有用ok做返回值），实在要返回中文，一般使用字典封装。防止他人调用你的函数时，不便根据你的中文返回值进行条件判断

 

 

g、性能因素，一般先判定false，再直接返回True的结果

 

 

h、函数中最好不要出现 print 或日志，防止他人调用时，打印没用的垃圾信息

 

 

i、测试代码时，注意测试实例选择（尽可能包揽各个方面的因素进行测试，可封装成测试函数（test）），并将测试代码放入 if __name__ == '__main__':中调用测试函数（test）进行测试

 

 

注意：

面试时写的代码尽量不要调用第三方库或函数来写，这样容易被面试官以三方库或函数来刁难你（1、你不用三方库或函数可以写吗？ 2、这个三方库或函数是怎么实现的？  等）

 

3、代码质量检测：

使用三方工具（静态代码质量检测）：pylint