全網最適合入門的物件導向程式設計教程:05 類和物件的Python實現-PyCharm程式碼標籤(一個幫你提升coding效率的小技巧)

FreakStudio發表於2024-06-30

摘要:

本文介紹了PyCharm IDE中程式碼標籤的定義、型別和使用方法。

往期推薦:

學嵌入式的你,還不會物件導向??!

全網最適合入門的物件導向程式設計教程:00 物件導向設計方法導論

全網最適合入門的物件導向程式設計教程:01 物件導向程式設計的基本概念

全網最適合入門的物件導向程式設計教程:02 類和物件的 Python 實現-使用 Python 建立類

全網最適合入門的物件導向程式設計教程:03 類和物件的 Python 實現-為自定義類新增屬性

全網最適合入門的物件導向程式設計教程:04 類和物件的Python實現-為自定義類新增方法

更多精彩內容可看:

給你的 Python 加加速:一文速通 Python 平行計算

一文搞懂 CM3 微控制器除錯原理

肝了半個月,嵌入式技術棧大彙總出爐

電子計算機類比賽的“武林秘籍”

一個MicroPython的開源專案集錦:awesome-micropython,包含各個方面的Micropython工具庫

文件和程式碼獲取

可訪問如下連結進行對文件下載:
https://github.com/leezisheng/Doc
image

本文件主要介紹如何使用 Python 進行物件導向程式設計,需要讀者對 Python 語法和微控制器開發具有基本瞭解。相比其他講解 Python 物件導向程式設計的部落格或書籍而言,本文件更加詳細、側重於嵌入式上位機應用,以上位機和下位機的常見串列埠資料收發、資料處理、動態圖繪製等為應用例項,同時使用 Sourcetrail程式碼軟體對程式碼進行視覺化閱讀便於讀者理解。
相關示例程式碼獲取連結如下:https://github.com/leezisheng/Python-OOP-Demo

正文

上一篇在類方法的註釋中,你可能已經發現每個方法下面一行都有:

#TODO:開啟串列埠方法待完成

在Pycharm中,它長這樣:
image

你可能在別的程式碼中看過類似的標識,如FIXME、NOTE、UNDONE等,這些是註釋中的標籤(tag),有時也被稱作“程式碼標籤(codetag)”或“標記(token)”。它們在編寫程式碼中屬於非正式使用的記號,但在專案開發中,能夠能讓程式碼編寫者在程式碼中起到提示、索引和快速定位的作用。在大多數 IDE 或文字編輯器當中,以如上所述標籤作為開頭的註釋,也會有特殊的語法高亮。程式碼標籤實際上就是一種特殊型別的註釋,這些註釋在編輯器中突出顯示、已編入索引並在 TODO 工具視窗中列出。
image

其中,TODO表示即將著手編寫的程式碼,說明需要完成的任務或實現的功能。
TODO格式如下:

# TODO(name): Need implementation

在Pycharm中,我們可以在下方導航欄中看到所有TODO標識的函式:
image

除了TODO外,還有FIXME標籤,表示需要修復的bug。透過使用程式碼標籤,在對包含多個檔案的專案進行編碼時,我們可以快速找到待完成的方法/函式以及待修復的bug。
image

相關文章