1. 程式人生 > >代碼風格與文件模板

代碼風格與文件模板

and htm rules eps 代碼 doc 提升 了解 線上

1.文件模板

敢問童鞋們,是否有見過其他人的pycharm代碼,上方總有一行“註釋”一樣的代碼?

技術分享圖片

既能保留當時寫代碼的時間,也能指定文件字符編碼,竟然還可以有一個署名!作者權呀!技術分享圖片

因此這部分教程主要介紹如何創建一個Python工程並使其具有Pycharm的代碼風格。你將會看到Pycharm使你的源碼變得非常簡潔美觀,帶有合適的縮進、空格等等,因此Pycharm也是一款代碼質量管理的利器。

打開一個新建的Python文件進行編輯(F4),這個文件中默認有兩行代碼:作者姓名和工程名稱。之所以會出現這兩行代碼,是因為Python文件在創建時是基於文件模板(官網介紹)進行創建的,因此會預定義這兩個變量。

那麽如何定義文件模板呢?

在settings > file and code templates > python script 選中,然後寫入模板語法!

技術分享圖片

模板語法如下:

pycharm官網具體模板語法在這: https://www.jetbrains.com/help/pycharm/file-template-variables.html

# -*- coding:utf-8 -*-
# Author : Oldboy
# Data : $DATE $TIME

那麽顯示效果如何呢?以後新建python文件後,都會自動添加上自定義的模板內容啦!

技術分享圖片

pep8代碼風格檢查

  寫python代碼,就得遵循官方定義的規矩,不以規矩就只能是野路子,無門無派。。。

那麽python定義了一系列,代碼風格規範,也就是pep8規範啦。

>>>>:戳這裏,查看具體風格http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/

  因此pycharm也提供了pep8代碼風格檢查,不符合規矩的,都會以波浪線提示有問題!

  輸入關鍵字class,當你開始輸入時,Pycharm的拼寫提示機制會立即列出選項來幫助你完成代碼:

技術分享圖片

(參照Pycharm拼寫提示來了解Pycharm更多關於拼寫提示的信息)

這個紅色波浪線標記了下次代碼輸入的期望位置,在這種情況下,它是一個預輸入定義符。鍵入類名Solver,紅色波浪線將會移動到類名之後。如果你將術鼠標指針懸停在波浪線上,將會看到所提示的錯誤信息("Colon expected"),當然,此時位於右側滾動欄的紅色標誌也會給出相同的錯誤信息。

技術分享圖片

聚焦PEP8代碼風格檢查

  然而,在默認情況下這些警告提醒是不可見的,所以首先需要做的就是提升它們的優先級以進行顯示。單擊技術分享圖片設置按鈕,然後在Settings/Preferences對話框中的 Inspections 頁面,鍵入PEP8來找到所有相關選項,在對應的下拉菜單中選中warning選項:

查找路徑:

settings > Editor > Inspections > python > PEP 8 coding style violation

技術分享圖片

詳解PEP8代碼風格

  現在Ptcharm已經能夠正常顯示它的代碼規範,確保你編寫的代碼格式的完整性。接下來當我們輸入下一條語句(例如def demo(self,a,b,c):),Pycharm將根據PEP8的代碼規範機制來報告當前存在的格式問題。

技術分享圖片

正如你所見到的那樣,Pycharm將其所支持的PEP8規範設置為默認的正規Python代碼格式標準。如果你打開inspections的列表,(Ctrl+Alt+S→Inspections),可以看到Pycharm在你的代碼中加載了pep8.py工具,用來精確定位你的代碼風格問題。

技術分享圖片

Pycharm提供的格式化代碼

代碼的格式問題是在是太多了,那麽如何方便的調整為美觀的代碼呢?

這裏所用到的就是code reformatting了,不妨嘗試一下。

為了調用格式化操作,只需按下Ctrl+Alt+L快捷鍵,或者在主菜單中單擊Code→Reformat Code,此時我們驚奇發現所有的PEP8類格式問題都已經消除。

  當然我們可以自定義格式化標準,打開 code style settings對話框,選擇指定語言(Python),進行必要的更改即可:

技術分享圖片

技術分享圖片

代碼風格與文件模板