Referencia
https://blog.csdn.net/mouday/article/details/80515308
https://blog.csdn.net/dkjkls/article/details/88933950
Plantilla de archivo personalizado
plantilla de archivo pycharm
Entrada:
Preferences --> Editor ---> File and Code Templates --> Python Script
pegar en el encabezado del archivo personalizado
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
"""
@File : ${NAME}.py
@Contact : [email protected]
@Author : name
@Modify Time @Version @Desciption
------------ -------- -----------
${DATE} ${TIME} 1.0 None
"""
Variable NAME DATE TIME viene con el editor pycharm
La información anterior se agregará automáticamente después del archivo recién creado
Referencia a otras variables:
${PROJECT_NAME} - 当前的项目名
${NAME} - 在文件创建过程中，新文件对话框的命名
${USER} - 当前的登录用户
${DATE} - 现在的系统日期
${TIME} - 现在的系统时间
${YEAR} - 当前年份
${MONTH} - 当前月份
${DAY} - 当前月份中的第几日
${HOUR} - 现在的小时
${MINUTE} - 现在的分钟
${PRODUCT_NAME} - IDE创建文件的名称
${MONTH_NAME_SHORT} - 月份的前三个字母缩写
${MONTH_NAME_FULL} - 完整的月份名
Referencia de estilo
# -*- coding: utf-8 -*-#
#-------------------------------------------------------------------------------
# Name: ${NAME}
# Description:
# Author: ${USER}
# Date: ${DATE}
#-------------------------------------------------------------------------------
documentación de docstring para pycharm
Establecer ubicación:
Preferences -> Tools -> Python Integrated Tools -> Docstrings -> Docstring format
Cinco estilos:
Plain
reStructuredText Ejemplo de estilo de
Numpy
Google
Epytext
# Plain
def foo1(a, b):
"""
"""
return a+b
# reStructuredText
def foo2(a, b):
"""
:param a:
:param b:
:return:
"""
return a+b
# Numpy
def foo3(a, b):
"""
Parameters
----------
a
b
Returns
-------
"""
return a+b
# Google
def foo4(a, b):
"""
Args:
a:
b:
Returns:
"""
return a + b
# Epytext
def foo(a, b):
"""
@param a:
@param b:
@return:
"""
return a+b
Agregue notas de método para personalizar accesos directos globales
El formato de cadena de documentos puede formatear y generar automáticamente cadenas de documentos, pero no puede agregar el creador, el tiempo de creación, el modificador, el tiempo de modificación, el aviso de copyright; algunas especificaciones sugieren que estos elementos están escritos en el encabezado del archivo, pero para el desarrollo colaborativo del mismo archivo, sienta Es necesario agregar estos elementos a cada método para hacerlo más claro.
Se puede lograr a través de la plantilla personalizada de Plantillas en vivo de pyCharm.
La ruta de configuración en Live Templates es la siguiente:
File -> Settings -> Editor -> Live Templates
haga clic para +crear una nueva plantilla y se generará automáticamente un grupo de usuarios. La abreviatura representa la tecla de acceso directo, y Descripción lo describe.
Después de configurar las teclas de acceso directo, debe establecer el alcance de uso y agregar contenido de plantilla. Si usa variables, debe establecer las variables y luego guardar el
alcance de la aplicación
Establecer variables
El alcance de uso general, las variables y el contenido de la plantilla deben configurarse
Referencia del archivo de plantilla:
:now_time: $DATE$ $TIME$
"""
Parameters
----------
Returns
-------
Examples
--------
--------
:Author: lduml
:Create: $DATE$ $TIME$
"""