1. 程式人生 > >利用PyCharm生成類似於Pytorch的高質量註釋

利用PyCharm生成類似於Pytorch的高質量註釋

在學習pytorch時,無意間發現pytorch的註釋寫的非常詳細。在pycharm中,輸入函式名後直接按Ctrl+Q即可快速開啟註釋視窗。隨便貼幾個感受一下:
這裡寫圖片描述
這裡寫圖片描述

可以看到,不僅可以在註釋中新增引數表格、說明、examples,還可以插入圖片、超連結和型別等資訊。
其實他們是用了谷歌的python docstring format。只需要在pycharm中稍微設定一下,便可以自動生成這種註釋模板。

具體方法為:
File->Settings->Tools->Python integrated Tools->Docstring format,把該框選為Google

即可。

使用時,每完成一個函式,換行後打三個雙引號,然後回車即可自動生成Google引數模板,我們只需要補全內容即可。