python开发设计规范

python开发设计规范

    a. 注释可以参考pycharm的自动注释格式""", 函数不需要每行代码都添加注释, 一个部分写一个注释即可

    b. 测试用例尽量都放在if __name__ == "__main__"里面

    c. 函数如果有返回值, 则最终的每个分支都要有返回值

    d. 封装给别人使用的函数内不要print或者logger没有出错的日志

    e. 测试用例的输出结果要让其他人能够一目了然知道发生了什么

    f. 变量名不要用|,o等等很容易看错的变量名

    g. 绝大多数情况下函数内if, for, while的嵌套不要超过3层

    h. 返回值如果是一个字符串, 一定不要返回中文, 最好返回值不要用字符串


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章