PyCharm中「Insert documentation comment stub」如何生成方法参数类型存根？

• 先给参数加类型注解
  PyCharm能自动生成带参数的文档存根，核心前提是得给方法参数标注好类型。给你的示例代码补上类型注解（记得先导入pandas）：

import pandas as pd

def get_self_join_clause(self, df: pd.DataFrame, alias1: str = 'o', alias2: str = 'n'):
    """
    
    """

• 检查文档字符串格式设置
  打开「File | Settings | Tools | Python Integrated Tools」，找到「Docstring format」选项，选择Google、NumPy或者reStructuredText这类支持参数自动填充的格式，选完点击应用保存。

• 重新生成文档存根
  删掉代码里现有的空三引号，在方法定义下方重新输入"""然后回车，PyCharm就会自动生成带参数和类型的文档存根了。比如选Google格式的话，生成结果会是这样：

def get_self_join_clause(self, df: pd.DataFrame, alias1: str = 'o', alias2: str = 'n'):
    """生成自连接子句

    Args:
        df: 要进行自连接的DataFrame
        alias1: 第一个表的别名，默认值'o'
        alias2: 第二个表的别名，默认值'n'

    Returns:
        自连接子句字符串
    """

• 偷懒技巧：用PyCharm自动加类型注解
  如果不想手动写类型，光标放在方法名上，按Alt + Enter（Windows/Linux）或Option + Enter（Mac），选择「Specify type for parameter」，PyCharm会自动推断参数类型并补上注解，之后再生成文档存根就有参数信息了。

内容的提问来源于stack exchange，提问作者WestCoastProjects