Python 3：记录模块

【问题标题】：Python 3: Documenting modulesPython 3：记录模块
【发布时间】：2012-09-24 06:56:17
【问题描述】：

我研究如何记录我的代码。所以，我准备了一个文件 docstrings.py 并将它放在一个目录中。现在我想看看我记录的内容。换句话说，我想输入 help(docstrings.square) 并在我的模块中获取有关 square 函数的文档。

>>> import sys
>>> sys.path.append("C:\Users\Michael\PycharmProjects\Docstrings")

结果：

SyntaxError：（unicode 错误）'unicodeescape' 编解码器无法解码位置 2-4 中的字节：截断 \UXXXXXXXX 转义

怎么了？

【问题讨论】：

【解决方案1】：

string literals 中的反斜杠必须加倍：

>>> sys.path.append("C:\\Users\\Michael\\PycharmProjects\\Docstrings")

除非你使用 原始字符串：

>>> sys.path.append(r"C:\Users\Michael\PycharmProjects\Docstrings")

【讨论】：

谢谢。它正在工作。另一个问题。如何使用 PyDoc。我读到 PyDoc 从 sys.path 探索所有目录并找到选定的模块。但是如何编辑 PyDoc 的 sys.path？
尝试修改PYTHONPATH 环境变量。 PyDoc 应该尊重它。