我目前正在浏览Jetbrains Pycharm 2017.1.5中的项目,记录我所有的python 3.6类和方法,并且有几个关于docstring格式的东西.
我想链接到某些文档字符串中的其他方法/函数/类,但我无法弄清楚如何执行此操作.restructuredText的文档非常非常广泛,但它没有说任何关于使用Pycharm引用其他文档字符串的内容.实际上,该页面中的绝大部分片段甚至都不能在Pycharm中运行.(这是为什么？)
我已经设法找到你可以:class:`<class_name>`用来引用一个类,但:class:`<class.method>`不起作用,类似命名的结构,如:func:`<func_name>`不创建超链接.我也看到:ref:`<name>`了,但那个也不起作用.
(如果没有这个错误,我会在心跳中切换到Epytext(它有我想要的一切,加上它更简单):You need configured Python 2 SDK to render Epydoc docstrings在Ctrl + Q帧中.)
如果有一种方法可以继承子类/重写方法中的docstring,那么它也会非常有用.如果您将docstring留空,Pycharm会自动执行此操作,这使我认为可以手动执行此操作.但是,我再也找不到任何相关信息.
事情变得非常复杂,如此简单.所以,任何帮助将不胜感激!