python開發設計規範

python開發設計規範

    a. 註釋可以參考pycharm的自動註釋格式""", 函數不需要每行代碼都添加註釋, 一個部分寫一個註釋即可

    b. 測試用例儘量都放在if __name__ == "__main__"裏面

    c. 函數如果有返回值, 則最終的每個分支都要有返回值

    d. 封裝給別人使用的函數內不要print或者logger沒有出錯的日誌

    e. 測試用例的輸出結果要讓其他人能夠一目瞭然知道發生了什麼

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

    g. 絕大多數情況下函數內if, for, while的嵌套不要超過3層

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


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