Pycharm IDE設(shè)置系列教程(二):配置代碼樣式
PyCharm是一種Python IDE,其帶有一整套可以幫助用戶在使用Python語言開發(fā)時(shí)提高其效率的工具。此外,該IDE提供了一些高級(jí)功能,以用于Django框架下的專業(yè)Web開發(fā)。
如果公司中存在某些編碼指南,則在創(chuàng)建源代碼時(shí)必須遵循這些指導(dǎo)原則。PyCharm可幫助您維護(hù)所需的代碼樣式。
代碼樣式在項(xiàng)目級(jí)別和 IDE級(jí)別(全局)定義。
在項(xiàng)目級(jí)別,設(shè)置按項(xiàng)目 方案分組,該 方案是預(yù)定義的,并以粗體標(biāo)記。該項(xiàng)目樣式方案僅應(yīng)用于當(dāng)前項(xiàng)目。
您可以使用“ 復(fù)制到IDE”命令將Project方案復(fù)制到IDE級(jí)別 。
在IDE級(jí)別,設(shè)置按預(yù)定義的默認(rèn) 方案(以粗體標(biāo)記)和用戶通過“ 復(fù)制” 命令(標(biāo)記為純文本)創(chuàng)建的任何其他方案 進(jìn)行分組 。當(dāng)用戶不希望將代碼樣式設(shè)置保留在項(xiàng)目中并共享它們時(shí),將使用全局設(shè)置。
您可以使用“ 復(fù)制到項(xiàng)目”命令將IDE方案復(fù)制到當(dāng)前項(xiàng)目 。
在“ 設(shè)置/首選項(xiàng)”對(duì)話框(Ctrl+Alt+S)中,轉(zhuǎn)到“ 編輯器”| 代碼樣式 并打開編程語言的頁面。
選擇代碼樣式方案,以用作所選語言的自定義編碼樣式的基礎(chǔ)。
瀏覽所選語言頁面的選項(xiàng)卡,并為其配置代碼樣式首選項(xiàng)。
對(duì)于大多數(shù)受支持的語言,您可以從其他語言或框架復(fù)制代碼樣式設(shè)置。
在“ 設(shè)置/首選項(xiàng)”對(duì)話框(Ctrl+Alt+S)中,轉(zhuǎn)到“ 編輯器”| 代碼樣式 并打開編程語言的頁面。
單擊右上角的“ 設(shè)置 ”。
僅顯示這些語言的鏈接,其中可以使用其他語言定義設(shè)置。
從顯示的列表中,選擇要從中復(fù)制代碼樣式的語言。
PyCharm允許您使用EditorConfig支持管理每個(gè)單獨(dú)文件集的所有代碼樣式設(shè)置(默認(rèn)情況下啟用) 在“ 設(shè)置/首選項(xiàng)”對(duì)話框中(Ctrl+Alt+S)。您需要做的就是在根目錄中放置一個(gè).editorconfig文件,其中包含您要定義其代碼樣式的文件。您可以根據(jù)需要在項(xiàng)目中包含盡可能多的.editorconfig文件,以便為不同的模塊指定不同的樣式。
editorconfig文件中的 所有選項(xiàng)都應(yīng)用于它所在的目錄以及當(dāng)前項(xiàng)目代碼樣式之上的所有子目錄。如果未定義任何內(nèi)容.editorconfig,則從項(xiàng)目設(shè)置中獲取。
editorconfig文件中的 所有選項(xiàng)分為以下類別:
標(biāo)準(zhǔn)選項(xiàng),如indent_size,indent_style等。這些選項(xiàng)沒有任何特定于域的前綴。
具有ij_前綴且適用于所有語言的通用IntelliJ選項(xiàng):
ij_visual_guides
ij_formatter_off_tag
ij_formatter_on_tag
ij_formatter_tags_enabled
ij_wrap_on_typing
ij_continuation_indent_size
ij_smart_tabs
許多(但不是全部)語言支持的常見IntelliJ選項(xiàng)。ij_any例如,它們以前綴開頭ij_any_brace_style。
特定于IntelliJ語言的選項(xiàng)以ij_
例如,可以將相同的選項(xiàng)定義為常用選項(xiàng)和特定于語言的選項(xiàng)ij_
在“ 項(xiàng)目”視圖中,右鍵單擊包含要定義其代碼樣式的文件的源目錄,然后選擇“ 新建”| 上下文菜單中的EditorConfig。
選擇要定義的屬性,以便PyCharm為它們創(chuàng)建存根,或者將所有復(fù)選框保留為空以手動(dòng)添加所需的屬性。
要預(yù)覽代碼樣式設(shè)置的更改將如何影響實(shí)際源文件,請(qǐng)單擊 .editorconfig 文件的左側(cè)裝訂線并選擇受其影響的源文件。預(yù)覽將在右側(cè)打開。
您可以在預(yù)覽窗格中進(jìn)行更改,以嘗試測(cè)試配置更改的反映方式,而不必?fù)?dān)心對(duì)源代碼進(jìn)行不必要的更改:關(guān)閉.editorconfig文件時(shí),所有這些更改都將被丟棄。
=====================================================
有關(guān)詳細(xì)信息,請(qǐng)繼續(xù)關(guān)注我們接下來的教程“Pycharm IDE設(shè)置系列教程”。我們很快就會(huì)發(fā)布涵蓋其他用途的文章。