让我们来想象一下,我想在PyCharm 4.5 Community Edition(在5.0中试用)中看到一个简单方法的文档字符串弹出窗口。PyCharm和reStructuredText(Sphinx)文档弹出窗口
我在这两个epytext语法写下这些文档字符串(epydoc的发电机是不支持的,因为2008年只为Python2作品)和新结构化语法(这是使用狮身人面像 - 积极支持发生器,用于官方python文档)在PyCharm文档弹出式窗口
的epytext一个完美的作品
PyCharm works with epytext Screenshot
但reStructuredText的一个不显示在任何参数二!
PyCharm fails with reStructuredText Screenshot
试图与PyCharm设置来处理这个问题,读PyCharm帮助,通过PyCharm错误追踪搜索和使用谷歌不能帮助我找到为什么PyCharm这些文档字符串弹出窗口无法正常工作的原因使用社区推荐的文档字符串标记语言。
这是因为该功能的低需求?也许,是否有一些有用的替代方法来查看PyCharm或其他IDE中的现代文档标记?我还需要能够生成HTML格式相当的文档。
我在这里找到了another topic,与同一个问题有关,但它自去年以来仍然没有答案。所以,我猜想我的期望在现代IDE中查看现代文档有什么问题。
这里是我的代码示例
def find_links(self, issue, link_type):
"""
Find all issues linked with C{issue} with C{link_type}.
@param issue: Issue key
@type issue: str
@param link_type: Accepts either Type Name (like 'Child') or Link Description (like 'child of')
@type link_type: str
@return: Keys of found issues
@rtype: list
"""
result_keys = []
link_list = self.get_link_list(issue)
for link in link_list:
... # omitted
return result_keys
def test_sphinx_docs_method(self, issue, link_type):
"""
Find all issues linked with *issue* with *link_type*.
:param issue: Issue key
:type issue: str
:param link_type: Accepts either Type Name (like 'Child') or Link Description (like 'child of')
:type link_type: str
:return: Keys of found issues
:rtype: list
"""
result_keys = []
link_list = self.get_link_list(issue)
for link in link_list:
... # omitted
return result_keys
非常感谢!奇怪,但如果从pycharm网站下载2016.1版本,目前该功能仍然有效,而且我的同事几个月前安装的那个版本不会! IDK的确切原因,可能是所有版本都有最新补丁(我测试过5.0.2和5.0.5,最新版本也适用于这个功能!) –