天天看點

pycharm配置Live Templates快速生成注釋

背景:

最近我們在推httprunner進行接口自動化測試,需要分工編寫一些用例,為了清晰得展示用例的資訊,規定了一些注釋格式和字段。但是每次自己敲比較費時費力,是以配置一下Live Templates

步驟:

首先需要建立一個Live Template

在File -> Settings -> Editor ->Live Templates

pycharm配置Live Templates快速生成注釋

因為我是要在Python裡面用,是以在Python下建立一個

pycharm配置Live Templates快速生成注釋

填寫Abbreviation,這個字段就是你的簡寫,在寫代碼的時候會聯想到。Description是描述,會在代碼聯想時提示出來。

pycharm配置Live Templates快速生成注釋

其中變量是用兩個$來包裹,比如我這裡就有4個變量

"""
:接口名:$API_NAME$
:接口位址:$API_URL$
~~~~~~~~~~~~~~~~~
:描述:$API_DESC$
:建立時間:$CREATE_TIME$

:author:trevor.zhao
"""
           

可以用Edit variableles對變量進行設定

pycharm配置Live Templates快速生成注釋

裡面的Expression可以參考官方文檔:https://www.jetbrains.com/help/pycharm/template-variables.html

最後注意一下作用域,我這裡隻是在python檔案的頂部用,是以在Class中輸入doci是聯想不出來的

pycharm配置Live Templates快速生成注釋

最終效果:

pycharm配置Live Templates快速生成注釋