文件名称:doc-gen:从文档中释放代码文件!
文件大小:9KB
文件格式:ZIP
更新时间:2024-05-06 16:49:16
Python
Doc-Gen 首先,什么不是Doc-Gen:它不会生成文档,也不会在您编写文档后发挥任何作用。 实际上,它确实如其名称所说:可以帮助您编写文档。 当我编写代码时,我经常发现很难编写文档字符串。 内联文档的这些内容使浏览文件变得很麻烦。 要将所有文档字符串移出文件,但仍使其他文档库仍可识别它们,这就是该库的目的。 如何使用这个库 该库有一个shell脚本doc和一个装饰器doc 。 很容易记住。 要使用此库,您必须使用doc装饰所需的功能,如下所示: # source.py @ doc def function ( x , y ): return 2 * x + y 然后,在终端中,您应该键入doc source.py ,并且应该看到提示询问您是否需要function的文档字符串。 笔记 该库使用与其提示相关的许多动作的quick_toolkit。 需要注意的一件事是,
【文件预览】:
doc-gen-master
----README.rst(2KB)
----mytest.py(74B)
----docstrings.json(36B)
----requirements.txt(39B)
----LICENSE(1KB)
----docs()
--------make.bat(795B)
--------reference.rst(1KB)
--------conf.py(2KB)
--------quickstart.rst(2KB)
--------index.rst(1KB)
--------Makefile(634B)
----.gitignore(65B)
----doc.py(5KB)
----pyproject.toml(385B)