代碼不規(guī)范，運(yùn)維兩行淚

編程江湖中一直盛傳著一個段子，那就是要問程序員最討厭哪 4 件事？那必須是：寫注釋、寫文檔、別人不寫注釋、別人不寫文檔。

動手寫代碼前盡量做到心中有數(shù)，思考清楚代碼框架結(jié)構(gòu)。現(xiàn)在這世界講究格局，寫代碼亦然。?寫代碼前先回答這么幾個問題——這段代碼的核心功能是什么？實(shí)現(xiàn)它的核心功能需要實(shí)現(xiàn)哪些functions? 這些functions需要設(shè)計(jì)哪些相應(yīng)的class？這些class如何盡量做到繼承，能否從已有的代碼庫里進(jìn)行繼承來避免重復(fù)開發(fā)？

能高效一行寫完的絕不寫兩行。?舉個簡單的python 例子，想要得到0到10的偶數(shù)，大部分人會通過遍歷+if判斷寫幾行代碼，但完全可以通過一行代碼達(dá)到結(jié)果

?

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

做好文檔規(guī)整。?程序員的工作不是學(xué)完代碼就拉倒的，還包括整理好自己代碼的文檔介紹，一方面方便工作交接，自己也方便匯報工作，另一方面方便給自己理清思路，為以后使用這份代碼做準(zhǔn)備。

坐姿端正，保護(hù)好你的頸椎。?老程序員都懂，頸椎不好多么影響工作效率。寫代碼時盡量用大屏，這樣不用低頭去寫，坐姿正確對頸椎、老腰都好，可持續(xù)輸出才是王道。

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

說下Pycharm使用的一些tips：

1、用好TODO

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

TODO注釋應(yīng)該在所有開頭處包含”TODO”字符串，后面可以根據(jù)個人偏好加上一行注釋，解釋要做什么之類的。主要目的是為了有一個統(tǒng)一的TODO格式，這樣添加注釋的人就可以搜索到

?

# TODO(domi): 優(yōu)化閾值# TODO(tony) : 調(diào)整變量

如果你的TODO是”將來做某事”的形式， 那么請確保你包含了一個指定的日期(“2009年11月解決”)或者一個特定的事件(“等到所有的客戶都可以處理XML請求就移除這些代碼”)。在你提交代碼到GitHub的時候，會提示你的todo內(nèi)容，方便你查看自己的待做事項(xiàng)

2、代碼設(shè)置模板

在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 :"""

3、習(xí)慣Matlab編程的人一開始會很不習(xí)慣Pycharm，沒法實(shí)時查看變量來調(diào)試代碼，如果想Pycharm查看變量，需要通過Python?Console，也可以使用Anaconda的Spyder模塊，開發(fā)界面和matlab類似，變量實(shí)時查看

推薦的Google Style代碼規(guī)范：

https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/contents/

總結(jié)

以上是生活随笔為你收集整理的2021-02-21 代码不规范，运维两行泪 代码规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。