目录
概述
每次新建py文件的时候,希望和Java项目一样,在文件前面加上作者,以及编码格式等信息,下面是具体是pycharm实现方法(这里是mac版本)
方法:
配置默认代码和注释
1.打开pycharm
2.到preference进入到设置页面
3.找到File and code Templates的Python Script设置,把下面的格式复制到这里,修改对应的名字
4.设置时间、作者、编码方式等注释
# -*- coding: utf-8 -*-
# @Time : ${DATE} ${TIME}
# @Author : kzl
# @File : ${NAME}.py
# @desc:
当然还有很多别的选项,一般设置上面的几个就基本足够了
当然还有更多的设置:
#!/usr/bin/env python
# encoding: utf-8
#@author: caopeng
#@license: (C) Copyright 2013-2017, Node Supply Chain Manager Corporation Limited.
#@contact: deamoncao100@gmail.com
#@software: garner
#@file: ${NAME}.py
#@time: ${DATE} ${TIME}
#@desc:
等下次新建模块的时候,就能够使用自己设置的注释内容了。
Docstring format 添加方法注释
我设置的是google样式
下面是不同风格的样式
def docstrings_func_plain(parm_a, parm_b, parm_c):
"""
Plain 风格
"""
def docstrings_func_epytext(parm_a, parm_b, parm_c):
"""
Epytext 风格
@param parm_a: 参数a
@param parm_b: 参数b
@param parm_c: 参数c
@return: 结果a
"""
def docstrings_func_restructuredtext(parm_a, parm_b, parm_c):
"""
reStructuredText 风格
:param parm_a: 参数a
:param parm_b: 参数b
:param parm_c: 参数c
:return: 结果a
"""
def docstrings_func_numpy(parm_a, parm_b, parm_c):
"""
NumPy 风格
Parameters
----------
parm_a : 参数a
parm_b : 参数b
parm_c : 参数a
Returns
-------
result_a : 结果a
"""
def docstrings_func_google(parm_a, parm_b, parm_c):
"""
Google 风格
Args:
parm_a: 参数a
parm_b: 参数b
parm_c: 参数c
Returns:
result_a 结果a
"""
好了就先到这
如果觉得本文对你有帮助,欢迎点赞,欢迎关注我,如果有补充欢迎评论交流,我将努力创作更多更好的文章。