如何让PyCharm在docstrings中找到Todo项目

Posted 2021-04-14

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了如何让PyCharm在docstrings中找到Todo项目相关的知识，希望对你有一定的参考价值。

我当时正在玩PyCharms TODO finder。这是一个很好的功能，我想更强烈地使用它。但是它没有找到我在我的文档字符串中使用的任何待办事项。

"""
Do something.

:todo: This is my Todo-Item that is sadly not found

"""
# Todo: When I use line comments it is found.
def my_function():
    pass

有没有办法配置PyCharm在文档字符串中查找待办事项？

答案

如果我做对了，PyCharm会在评论之间产生影响

# Comment

和docstrings喜欢

"""
My function does this and that.

"""

只在评论中查找TODO条目。所以

"""
My function does this and that.

todo: add something else

"""

不会工作。

另一答案

自2017.3版以来，PyCharm支持Docstrings中的TODO

以上是关于如何让PyCharm在docstrings中找到Todo项目的主要内容，如果未能解决你的问题，请参考以下文章