sangfor的代码规范

目录

以下为部分摘取:

提升


在sangfor提交代码就是一个不断被dis,然后不断修改再提交的体验。

sangfor的python代码规范是严格遵循pep8的代码规范的

以下为部分摘取:

变量文件名的命名,小写单词与单词之间下划线相连,常量则要为全大写,类名为大驼峰命名法。

每一个文件的命名,每一个类的命名,每一个函数的命名,每一个变量的命名都要尽可能做到命名,每一个函数都要遵循格式写注释

代码格式空行都要做到非常规范,最后一行代码必须要且留一行空行而且这空行不能带空格,代码之间的注释必须单独一行 不能放在同行代码后面

注释:有错别字 描述不够明了都要改 commit上去 审核不行 退回来改再commit 审核不行继续退回来继续改 若还是审核不满意还是会继续退回来改的

在git上commit 的描述也是要非常规范的 增加的必须用[Add ] 修改必须用[Fix ]开头 即使add后面少一个空格也会被要求重新commit

代码每行长度不能超100 

try except 中一定要指明捕获的exception的类型

每个if都要有与之对应的else防止有情况没被覆盖

用例中创建创建的文件名要用uuid创建32位的随机码防止文件名冲突

正则表达式要做到看表达式就能知道要匹配的内容 

返回用于断言的数据要求代码即注释res [0]这样是要改为res[“name”]的

即注释 不然leader审核代码肯定会指出让你修改 

审核者觉得有看不懂或疑惑的都需要加注释或者修改写法。

提升

只要不规范就要修改,对像我这样刚刚毕业的新手来说,是一个非常好的成长平台,从开始就养成代码规范的好习惯。

最大的感觉就是自己写的程序越来越向PEP8标准看齐。

猜你喜欢

转载自blog.csdn.net/chuancheng_zeng/article/details/115202628