【Python自學筆記】Pycharm如何快速給python函數添加說明文檔&參數註釋

Pycharm添加參數註釋（說明文檔）

我們在寫 Python函數 或 自定義類 的時候，往往會需要給裏面的參數或者變量添加註釋，這樣的作用是使其他使用的人一個很好的說明，從而讓他人更好的使用我們的代碼

快速添加註釋（Pycharm環境）

• 我們在寫好一個函數之後，直接把鼠標移至函數名上等一兩秒中後，pycharm就會出現一個黃色的💡圖標
• 然後點擊💡圖標右側的下三角
• 選擇Insert documentation string stub
  
• 然後手動填寫相應的說明即可

查看註釋

• 調用函數，把鼠標放在函數名上然後可以通過兩種方法查看註釋
  –快捷鍵：Ctrl + Q
  – 工具欄選擇View --> Quick Documentation
• 通過以上兩種方法可以查看設置好的註釋說明