Roe*_*urg 16 python documentation documentation-generation jupyter jupyter-notebook
我正在使用 python 的 jupyter 笔记本中工作,并尝试使用自动文档功能来生成如下所示的文档字符串。在像 pycharm 这样的 IDE 中工作时,函数下方的三重引号 + Enter 会生成如下所示的文档字符串。
def test_function(df: pd.DataFrame, probs: dict) -> int:
"""
:param df:
:param probs:
:return:
"""
Run Code Online (Sandbox Code Playgroud)
目前,我的笔记本输出给出了以下输出,并且不解析函数内的任何参数。
def test_function(df: pd.DataFrame, probs: dict) -> int:
"""
"""
Run Code Online (Sandbox Code Playgroud)
您可以在 VScode、sublime、pytorch 和其他 IDE 中使用该功能,但在 jupyter 中则不行。我发现的最接近的解决方案是安装 nbextensions并使用代码片段添加文档字符串模板。它减少了 50% 的打字量,但仍然不能自动生成。
归档时间: |
|
查看次数: |
894 次 |
最近记录: |