前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >pycharm使用笔记3-自动生成文件注释和函数注释

pycharm使用笔记3-自动生成文件注释和函数注释

作者头像
锦小年
发布2019-05-27 07:40:03
2.9K0
发布2019-05-27 07:40:03
举报
文章被收录于专栏:锦小年的博客锦小年的博客

版权声明:本文为博主原创文章,未经博主允许不得转载。python版本为python3,实例都是经过实际验证。 https://cloud.tencent.com/developer/article/1436384

1. 文件注释

pycharm提供了一个在新建文件自动生成文件头注释的功能,可以实现自动生成运行环境,作者、日期等必要信息,使用比较方便,配置十分简单。

按照1-5的路径选项即可。在5中填写想要的注释。

我的模板:

代码语言:javascript
复制
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
'''
@File    :   ${NAME}.py    
@Contact :   raogx.vip@hotmail.com
@License :   (C)Copyright 2017-2018, Liugroup-NLPR-CASIA

@Modify Time      @Author    @Version    @Desciption
------------      -------    --------    -----------
${DATE} ${TIME}   gxrao      1.0         None
'''

# import lib

2. 函数注释

自动生成函数注释,包括参数和返回值。

使用方法,函数定义时,直接输入三个双引号后回车,例如:

代码语言:javascript
复制
def a(b,c):

另起一行,输入三个引号,后回车

代码语言:javascript
复制
def a(b,c):
"""

结果:

代码语言:javascript
复制
def a(b,c):
    """
    :param b:
    :param c:
    :return:
    """
本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2018年10月26日,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 1. 文件注释
  • 2. 函数注释
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档