pycharm 快速文档(CTRL+Q)不加载本地文档文件

Question

我使用的是 pycharm 2016.1。

我有一个函数记录如下:

def extract_filename(filepath, ext=None):
    """
    This function returns the filename from a complete filepath including its extension.
    If ext is set to an extension it is removed from the filename.


    Parameters
    ----------
    filepath : string
    ext : string

    Returns
    -------
    string
    """

    if ext[0] != ".":
        ext = "." + ext

    filename = filepath.split("/")[-1]
    if ext is not None:
        filename = filename.split(ext)[0]

    return filename

我原以为一旦此文档准备就绪，我就可以在按 CTRL + Q 时弹出的快速文档窗口中看到它。然而，事实并非如此。该窗口仅显示类型推断:

def extract_filename(filepath, ext=None) Inferred type: (filepath: Union[str, unicode], ext: Union[str, unicode]) -> Union[str, unicode]

我在这里错过了什么？我认为通过记录我的函数，它的描述和参数会以很好的格式显示。

我找到了这篇文章:Documenting Python parameters in docstring using PyCharm .但是希望使用 NumPy 格式来编写文档。

谢谢!

Answer 1

首先，进入设置面板:文件 -> 设置。然后搜索docstring，将Docstring格式改成这样:

工具 > Python 集成工具 > 文档字符串 > 文档字符串格式 > NumPy

访问https://stackoverflow.com/a/24385103/6324442会有帮助。

其他文档:http://www.sphinx-doc.org/en/stable/ext/napoleon.html