pycharm 代码模板

PyCharm支持代码模板,这些模板可以帮助你更快地编写代码,提高开发效率。

新建类模板:

python
class $NAME$: def __init__(self, $PARAM$): self.$PARAM$ = $PARAM$ $END$

这个模板创建一个新的类,包含一个初始化方法。

新建函数模板:

python
def $NAME$($PARAM$): """ $DESCRIPTION$ """ $END$

这个模板创建一个新的函数,并包含了一个docstring。

if语句模板:

python
if $CONDITION$: $BODY$ else: $ELSE_BODY$

这个模板用于创建一个带有if-else语句的代码块。

for循环模板:

python
for $VAR$ in $ITERABLE$: $BODY$

这个模板用于创建一个for循环。

try-except语句模板:

python
try: $BODY$ except $EXCEPTION$ as $E$: $EXCEPT_BODY$

这个模板用于创建一个try-except语句块。

打开PyCharm并导航到"File" -> "Settings",然后选择"Editor" -> "Live Templates"。

在"Live Templates"窗口中,你可以看到现有的模板,也可以添加自己的模板。

点击"+"按钮添加一个新的模板,然后填写模板的缩写、描述和模板代码。

定义模板变量,例如,使用$VARIABLE$表示一个变量,定义变量的默认值和描述。

确认保存。

使用变量和表达式:
在模板中,你可以使用变量和表达式来动态生成代码。例如,使用$SELECTION$变量来插入被选中的文本,或者使用$DATE$来插入当前日期。

python
# 例子:插入选中文本 # Template code: print("Selected text: $SELECTION$")

嵌套模板:
你可以在一个代码模板中嵌套另一个代码模板,以构建更复杂的代码结构。

python
# 例子:嵌套模板 # Outer template code: def $FUNCTION_NAME$($PARAMETERS$): $BODY$ # Inner template code (nested inside the BODY of the outer template): if $CONDITION$: $INNER_BODY$

使用宏:
宏是一种更高级的模板功能,它允许你在模板中执行一些逻辑。你可以使用宏来生成复杂的代码片段。

python
# 例子:使用宏生成带有日志的函数 # Template code: def $FUNCTION_NAME$($PARAMETERS$): $LOG_MACRO$ $BODY$ # 定义 LOG_MACRO 宏 # Macro code: print(f"Entering {NAME} function")

模板上下文:
你可以为模板定义上下文,使其仅在特定情况下可用。这可以通过选择"Define"选项中的"Applicability"来实现。

python
# 例子:定义模板上下文,仅在类中可用 # Template code: def $METHOD_NAME$($PARAMETERS$): $BODY$ # Applicability 设置为 inClass()