Python允许单行/多行注释和文档字符串。在本文中,您可以找到如何在PyCharm中搜索和替换多行注释/文档字符串的正则表达式。
在此链接上,您可以找到PyCharm正则表达式语法参考。
为了开始搜索/替换菜单:
-
按CTRL+R打开搜索和替换窗格
-
选中正则表达式复选框
-
在顶部字段中输入搜索字符串
-
像这样转义元字符:
.[{()\^$|?*+
-因此在?
代码中搜索应通过以下方式完成\?
目录
-
匹配Python单行注释
-
匹配Python单行和多行文档字符串
-
PyCharm代码检查是否有损坏的文档字符串
匹配Python单行注释
可以通过此正则表达式选择单个python注释:
#.*\n
现在,如果要删除注释并使代码更具可读性,则可以将其替换为空字符串。您可以找到演示,在清除注释后如何更清楚地读取代码:
Halite III PyCharm集成和自定义类的导入-中间是所有注释中的代码清除。
匹配Python单行和多行文档字符串
现在到文章的主要主题-如何仅将文档注释与Python匹配:
单文档字符串
def kos_root():
"""Return the pathname of the KOS root directory."""
global _kos_root if _kos_root: return _kos_root
多行文档字符串
def complex(real=0.0, imag=0.0):
"""Form a complex number.
Keyword arguments:
real -- the real part (default 0.0)
imag -- the imaginary part (default 0.0)
"""
if imag == 0.0 and real == 0.0:
return complex_zero ...
有几个用于匹配单行和多行docstring的正则表达式,例如(该选项在大多数情况下应该工作,但有一些例外):
选项一
"""[\s\S]*?"""
选项二
"""[\d\D]*?"""
选项三
"""[\w\W]*?"""
选项四
(['"])\1\1[\d\D]*?\1{3}
选项五
([^:]"""[^\(]*)"""
PyCharm代码检查是否有损坏的文档字符串
您还可以使用PyCharm代码检查,以在代码中找到未记录的方法/类。这可以通过以下方式完成:
-
设置(文件/设置)- CTRL+ ALT+S
-
编辑
-
视察
-
搜索文档字符串
-
启用功能:文档字符串缺失或为空
-
此检查检测到缺少文档字符串和空文档字符串。