首先我知道没有什么可以完全自动记录，我知道，我只是询问任何可以帮助我快速制作文档的工具。
我差不多完成了我的scrapy项目，我想记录代码，是的我很糟糕我在开发过程中没有做文档：
无论如何，我发现狮身人面像听起来不错但是真的需要努力才能记录，而且它只是为项目提供了一个网页，我正在寻找一些可以做这样的工具：
如果我的代码是：
def myfucnction(var1, var2):
return 3+3;
所以代码应该编辑源代码并添加所需的第一语法，如"""
然后我发现sphinx api doc听起来不错，它会生成很多文件，有点小气但我可以编辑它们。尽管如此，它没有在我的代码中添加任何关于函数和类的内容，它只为我拥有的每个python脚本创建了第一个文件。这对我来说并不是件好事，因为对于我的经理来说，我们需要为每个函数记录输入并返回文档和一些关于函数的文本（真的很少）
这里我要求你的建议，帮助。这是我的第一个python项目，希望你能帮助我
我当时希望有一个工具可以生成文档模板，我会更新这些模板
答案 0 :(得分：1)
您可以做的是获得现代IDE的帮助。
例如，PyCharm有一个内置的＆＃34; Missing docstring＆＃34;具有修复能力的代码检查 - 插入文档字符串。例如，如果您有此代码：
def test(a, b):
return a + b
如果您使用PyCharm进行检查，则应用＆＃34; Missing docstring＆＃34;修复，Pycharm将自动生成所需格式的文档字符串模板：
def test(a, b):
"""
:param a:
:param b:
:return:
"""
return a + b
还有更多 - 它可以配置：