最全Pycharm教程（25）——Pycharm編輯器功能之查看幫助文檔

一、準備工做

　　（1）Pycharm版本爲2.7或者更高

　　（2）與product documentation的注意事項保持一致

　　（3）已經建立了一個工程而且至少向其中添加了兩個腳本文件，詳見Getting Started

　　二、快速查看定義

　　當你只是想知道相關的聲明信息時，不妨使用Quick definition，而無需跳轉到實際的定義位置。例如，將光標定位在一個表達式上，而後在主菜單中選擇View→Quick Definition：

　　你能夠在彈出的窗口中看到相關的快速定義信息，而後經過方向鍵來移動瀏覽整個提示信息。

　　單擊按鈕，在Find tool window窗口中找到快速定義信息：

　　三、快速查看幫助文檔

　　快捷（幫助）文檔顯示了當前符號的文檔註釋以及相關注釋符。咱們再次將光標定位在某個表達式上，此次咱們使用View→Quick Documentation的菜單命令。

　　在彈出的窗口中咱們一樣能夠經過左右方向鍵來瀏覽這個文檔信息：

　　固然咱們能夠調整彈出窗口的大小。單擊彈出尺寸調節滾動條，拖動滑塊來改變當前尺寸：

　　單擊按鈕，在Documentation tool window窗口中打開快速幫助文檔：

　　單擊恢復到原來的窗口形式。

　　四、查看外部文檔

　　這個命令容許你經過默認瀏覽器查看詳細幫助文檔信息：

　　順便提一句，你能夠經過quick documentation pop-up window來打開外部幫助文檔，能夠單擊或者按下Shift+F1快捷鍵。

　　外部文檔用到的PyQt4，PySide，gtk，wx，numpy，scipy，和kivy等第三方庫都是默認版本的，若是你想查看其它版本下的幫助文檔，例如Pyramid，請到 Python External Documentation對應位置參考。

　　五、瀏覽參數信息

　　這個命令能夠顯示函數方法的形參信息：

　　六、瀏覽環境上下文信息

　　最後，你能夠經過彈出窗口來瀏覽代碼塊開始部分的特定的符號信息。舉個例子，咱們將光標定位在一個exception上，而函數的聲明位於當前可視編輯範圍以外，而後按下Alt+Q或者View→Context Info菜單命令：

原文出處：CSDN博客
本文轉自SDK社區（https://www.sdk.cn/）