Question

我有很多python文件。

每个文件都有功能。而已。我不会对课程做任何事情。

Sphinx（或其他文档软件）是否仍会为其创建文档，如果是，它会是什么样子？

Answer 1

是的，当然。这是在Python中编程的许多常规方法之一。您不必使用类 - 事实上，Python附带的许多模块只是函数的集合。任何Python文档工具都将准备好处理这个问题。

Answer 2

理想情况下，Python函数和类都以语言（和文档生成软件）可以看到的特定方式记录，称为docstring。如果在每个函数定义之后立即放置一个字符串，如下所示：

def double(number):
    """Returns number times 2. May behave poorly if number isn't actually a number"""
    return number * 2;

...然后您可以从double获取double.__doc__函数的文档字符串。

有关如何编写好文档字符串的更详细说明，请参阅PEP8。搜索“文档字符串”以跳到您关注的部分。