天天看點

新年小目标!代碼更規範!代碼不規範,運維兩行淚

代碼不規範,運維兩行淚

程式設計江湖中一直盛傳着一個段子,那就是要問程式員最讨厭哪 4 件事?那必須是:寫注釋、寫文檔、别人不寫注釋、别人不寫文檔。

動手寫代碼前盡量做到心中有數,思考清楚代碼架構結構。現在這世界講究格局,寫代碼亦然。 寫代碼前先回答這麼幾個問題——這段代碼的核心功能是什麼?實作它的核心功能需要實作哪些functions? 這些functions需要設計哪些相應的class?這些class如何盡量做到繼承,能否從已有的代碼庫裡進行繼承來避免重複開發?

能高效一行寫完的絕不寫兩行。 舉個簡單的python 例子,想要得到0到10的偶數,大部分人會通過周遊+if判斷寫幾行代碼,但完全可以通過一行代碼達到結果

y = [x for x in range(10) if x % 2==0]      

做好文檔規整。 程式員的工作不是學完代碼就拉倒的,還包括整理好自己代碼的文檔介紹,一方面友善工作交接,自己也友善彙報工作,另一方面友善給自己理清思路,為以後使用這份代碼做準備。

坐姿端正,保護好你的頸椎。 老程式員都懂,頸椎不好多麼影響工作效率。寫代碼時盡量用大屏,這樣不用低頭去寫,坐姿正确對頸椎、老腰都好,可持續輸出才是王道。

新年小目标!代碼更規範!代碼不規範,運維兩行淚

Setup好用的IDE事半功倍。 我寫Python用Pycharm

說下Pycharm使用的一些tips:

1、用好TODO

為臨時代碼使用TODO注釋,它是一種短期解決方案。不算完美,但夠好了。

TODO注釋應該在所有開頭處包含”TODO”字元串,後面可以根據個人偏好加上一行注釋,解釋要做什麼之類的。主要目的是為了有一個統一的TODO格式,這樣添加注釋的人就可以搜尋到

# TODO(domi): 優化門檻值
# TODO(tony) : 調整變量      

如果你的TODO是”将來做某事”的形式, 那麼請確定你包含了一個指定的日期(“2009年11月解決”)或者一個特定的事件(“等到所有的客戶都可以處理XML請求就移除這些代碼”)。在你送出代碼到GitHub的時候,會提示你的todo内容,友善你檢視自己的待做事項

2、代碼設定模闆

在settings->Editor->file and code templates

新年小目标!代碼更規範!代碼不規範,運維兩行淚
# !/usr/bin/env python
# -*- encoding: utf-8 -*-
"""
@File   : ${NAME}.py    
@Contact: xxxxx
@Usage  : 
@Modify Time        @Author        @Version        @Desciption
------------        -------        --------        -----------
${DATE} ${TIME}     domi           1.0             None
@TODO   :
"""