PyCharm docstring中>>>前缀代码语法归属及规范问询

• 该语法不是PyCharm专属特性，是Python标准库doctest模块定义的可执行测试用例写法，相关约定被纳入了PEP 257（文档字符串规范）的推荐写法范畴，属于Python生态通用的文档示例标注规则。
• 这种写法的核心作用是让文档里的示例可以直接被doctest模块识别运行，作为单元测试用例验证代码逻辑和文档描述是否一致。
• 你没有在reStructuredText、Sphinx官方基础文档里找到相关说明的原因是，这部分属于Python本身的文档规范，不属于reST的语法定义。Sphinx可以通过sphinx.ext.doctest扩展支持这类示例的识别和运行，属于生态层面的适配。
• PyCharm的高亮支持是对Python通用规范的适配，除了代码高亮外，编辑器还支持直接右键运行这类docstring内的示例代码，快速验证执行结果。

示例写法参考：

def foo(x):
  """
  Use it like:

  >>> foo(42)
  """
  print(x)

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