PyCharm添加自动函数文档注释

规范的函数文档注释有助于他人理解代码，便于团队协作、提高效率。但如果我们自己手写函数文档注释将非常耗时耗力。PyCharm安装后默认没有开启自动化函数文档注释，需要我们开启

开启步骤：

File -> Settings -> Tools -> Python Integrated Tools -> Docstrings -> Docstring format

在这里插入图片描述

Docstring format包括五种风格：

Plain（默认）、Epytext、reStructuredText、NumPy和Google

其中，常用的是

Epytext

和

reStructuredText

风格

1）

Epytext

效果：

defdocstrings(param1, param2):"""
    Epytext风格
    @param param1:
    @param param2:
    @return:
    """...

2）

reStructuredText

效果：

defdocstrings(param1, param2):"""
    reStructuredText风格
    :param param1:
    :param param2:
    :return:
    """...

标签： pycharm ide

本文转载自: https://blog.csdn.net/weixin_55629186/article/details/135113949
版权归原作者对许所有，如有侵权，请联系我们删除。