代码风格与文件模板
1.文件模板
敢問(wèn)童鞋們,是否有見(jiàn)過(guò)其他人的pycharm代碼,上方總有一行“注釋”一樣的代碼?
既能保留當(dāng)時(shí)寫(xiě)代碼的時(shí)間,也能指定文件字符編碼,竟然還可以有一個(gè)署名!作者權(quán)呀!
?
因此這部分教程主要介紹如何創(chuàng)建一個(gè)Python工程并使其具有Pycharm的代碼風(fēng)格。你將會(huì)看到Pycharm使你的源碼變得非常簡(jiǎn)潔美觀,帶有合適的縮進(jìn)、空格等等,因此Pycharm也是一款代碼質(zhì)量管理的利器。
打開(kāi)一個(gè)新建的Python文件進(jìn)行編輯(F4),這個(gè)文件中默認(rèn)有兩行代碼:作者姓名和工程名稱(chēng)。之所以會(huì)出現(xiàn)這兩行代碼,是因?yàn)镻ython文件在創(chuàng)建時(shí)是基于文件模板(官網(wǎng)介紹)進(jìn)行創(chuàng)建的,因此會(huì)預(yù)定義這兩個(gè)變量。
那么如何定義文件模板呢?
在settings > file and code templates > python script 選中,然后寫(xiě)入模板語(yǔ)法!
模板語(yǔ)法如下:
pycharm官網(wǎng)具體模板語(yǔ)法在這: https://www.jetbrains.com/help/pycharm/file-template-variables.html
# -*- coding:utf-8 -*- # Author : Oldboy # Data : $DATE $TIME那么顯示效果如何呢?以后新建python文件后,都會(huì)自動(dòng)添加上自定義的模板內(nèi)容啦!
pep8代碼風(fēng)格檢查
寫(xiě)python代碼,就得遵循官方定義的規(guī)矩,不以規(guī)矩就只能是野路子,無(wú)門(mén)無(wú)派。。。
那么python定義了一系列,代碼風(fēng)格規(guī)范,也就是pep8規(guī)范啦。
>>>>:戳這里,查看具體風(fēng)格http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/
因此pycharm也提供了pep8代碼風(fēng)格檢查,不符合規(guī)矩的,都會(huì)以波浪線提示有問(wèn)題!
輸入關(guān)鍵字class,當(dāng)你開(kāi)始輸入時(shí),Pycharm的拼寫(xiě)提示機(jī)制會(huì)立即列出選項(xiàng)來(lái)幫助你完成代碼:
(參照Pycharm拼寫(xiě)提示來(lái)了解Pycharm更多關(guān)于拼寫(xiě)提示的信息)
這個(gè)紅色波浪線標(biāo)記了下次代碼輸入的期望位置,在這種情況下,它是一個(gè)預(yù)輸入定義符。鍵入類(lèi)名Solver,紅色波浪線將會(huì)移動(dòng)到類(lèi)名之后。如果你將術(shù)鼠標(biāo)指針懸停在波浪線上,將會(huì)看到所提示的錯(cuò)誤信息("Colon expected"),當(dāng)然,此時(shí)位于右側(cè)滾動(dòng)欄的紅色標(biāo)志也會(huì)給出相同的錯(cuò)誤信息。
聚焦PEP8代碼風(fēng)格檢查
然而,在默認(rèn)情況下這些警告提醒是不可見(jiàn)的,所以首先需要做的就是提升它們的優(yōu)先級(jí)以進(jìn)行顯示。單擊設(shè)置按鈕,然后在Settings/Preferences對(duì)話框中的?Inspections?頁(yè)面,鍵入PEP8來(lái)找到所有相關(guān)選項(xiàng),在對(duì)應(yīng)的下拉菜單中選中warning選項(xiàng):
?查找路徑:
settings > Editor > Inspections > python > PEP 8 coding style violation
詳解PEP8代碼風(fēng)格
現(xiàn)在Ptcharm已經(jīng)能夠正常顯示它的代碼規(guī)范,確保你編寫(xiě)的代碼格式的完整性。接下來(lái)當(dāng)我們輸入下一條語(yǔ)句(例如def demo(self,a,b,c):),Pycharm將根據(jù)PEP8的代碼規(guī)范機(jī)制來(lái)報(bào)告當(dāng)前存在的格式問(wèn)題。
?
正如你所見(jiàn)到的那樣,Pycharm將其所支持的PEP8規(guī)范設(shè)置為默認(rèn)的正規(guī)Python代碼格式標(biāo)準(zhǔn)。如果你打開(kāi)inspections的列表,(Ctrl+Alt+S→Inspections),可以看到Pycharm在你的代碼中加載了pep8.py工具,用來(lái)精確定位你的代碼風(fēng)格問(wèn)題。
?
Pycharm提供的格式化代碼
代碼的格式問(wèn)題是在是太多了,那么如何方便的調(diào)整為美觀的代碼呢?
這里所用到的就是code reformatting了,不妨嘗試一下。
為了調(diào)用格式化操作,只需按下Ctrl+Alt+L快捷鍵,或者在主菜單中單擊Code→Reformat Code,此時(shí)我們驚奇發(fā)現(xiàn)所有的PEP8類(lèi)格式問(wèn)題都已經(jīng)消除。
當(dāng)然我們可以自定義格式化標(biāo)準(zhǔn),打開(kāi)?code style settings對(duì)話框,選擇指定語(yǔ)言(Python),進(jìn)行必要的更改即可:
轉(zhuǎn)載于:https://www.cnblogs.com/cainingning/p/9374573.html
總結(jié)
- 上一篇: LUOGU P2827 蚯蚓 (noip
- 下一篇: 移动端的小问题整理