Referência
https://blog.csdn.net/mouday/article/details/80515308
https://blog.csdn.net/dkjkls/article/details/88933950
Modelo de arquivo personalizado
modelo de arquivo pycharm
Entrada:
Preferences --> Editor ---> File and Code Templates --> Python Script
colar no cabeçalho do arquivo 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
"""
A variável NAME DATE TIME vem com o editor de pycharm
As informações acima serão adicionadas automaticamente após o arquivo recém-criado
Referência a outras variáveis:
${PROJECT_NAME} - 当前的项目名
${NAME} - 在文件创建过程中，新文件对话框的命名
${USER} - 当前的登录用户
${DATE} - 现在的系统日期
${TIME} - 现在的系统时间
${YEAR} - 当前年份
${MONTH} - 当前月份
${DAY} - 当前月份中的第几日
${HOUR} - 现在的小时
${MINUTE} - 现在的分钟
${PRODUCT_NAME} - IDE创建文件的名称
${MONTH_NAME_SHORT} - 月份的前三个字母缩写
${MONTH_NAME_FULL} - 完整的月份名
Referência de estilo
# -*- coding: utf-8 -*-#
#-------------------------------------------------------------------------------
# Name: ${NAME}
# Description:
# Author: ${USER}
# Date: ${DATE}
#-------------------------------------------------------------------------------
documentação da documentação para pycharm
Definir local:
Preferences -> Tools -> Python Integrated Tools -> Docstrings -> Docstring format
Cinco estilos:
Plain
reStructuredText
Numpy
Google
Epytext
exemplo estilo
# 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
Adicione notas de método para personalizar atalhos globais
O formato Docstring pode formatar e gerar automaticamente docstrings, mas não pode adicionar o criador, hora da criação, modificador, hora da modificação, aviso de direitos autorais; algumas especificações sugerem que esses elementos sejam escritos no início do arquivo, mas, para o desenvolvimento colaborativo do mesmo arquivo, acho que ainda é Esses elementos precisam ser adicionados a cada método para torná-lo mais claro.
Pode ser alcançado através do modelo personalizado de modelos dinâmicos do pyCharm.
O caminho da configuração nos Modelos Ativos é o seguinte:
File -> Settings -> Editor -> Live Templates
Clique para +criar um novo modelo e um grupo de usuários será gerado automaticamente.A abreviação representa a tecla de atalho e Descrição a descreve.
Após definir as teclas de atalho, é necessário definir o escopo de uso e adicionar o conteúdo do modelo.Se você usar variáveis, precisará definir as variáveis e, em seguida, salvar o
escopo do aplicativo
Definir variáveis
Escopo de uso geral, variáveis e conteúdo do modelo precisam ser definidos
Referência do arquivo de modelo:
:now_time: $DATE$ $TIME$
"""
Parameters
----------
Returns
-------
Examples
--------
--------
:Author: lduml
:Create: $DATE$ $TIME$
"""