PyCharm快速插入注释文档

问题描述

PyCharm如何快速插入这样的注释文档

class A:
    def f(self, a, b, c):
        """
        
        :param a: 
        :param b: 
        :param c: 
        :return: 
        """
        pass

解决方案

方法一

在函数定义下一行敲六个双引号"""""" → 回车

方法二

在函数名处 Alt + Enter → Add parameters to docstring

可以注意到方法二生成的没有 return

可折叠注释

选中代码 → Code → Surround With… → <editor-fold…> Comments 或 region…endregion Comments

可使用快捷键 Ctrl + Alt + Win + T

# region 你好
print('Hello Word')
# endregion

参考文献

1. Create documentation comments
2. PyCharm类型提示方法