这里介绍下自己用的两种注释方法

本人这里用pycharm开发

rsStructuredText风格:

        """
注释

:param title: 标题
:type title: str
:param username: 名字
:type username: str
:param text: 内容
:type text: str
:param msgType: 内容类型
:type msgType: str
:return:
:rtype:
"""

"""
注释

:param title: 标题
:param username: 名字
:param text: 内容
:param msgType: 内容类型
:return:
"""


google风格:

        """
注释

Args:
title: 标题
username: 名字
text: 内容
msgType: 内容类型

Returns:
"""


效果都一样

ctrl+q:显示

开发第一步---注释_.