在过去的三个月中，我一直在公司的一个单独项目中工作。因为我的工作大部分都是由编码组成的，所以我自然会生成一些代码（大约2000行），因此我试图尽可能地做出明智的评论。
在这个项目中，我使用了许多抽象的python概念，并且在项目的一部分中，我大量使用了一流的函数。在这一部分中，我将根据其他函数动态生成函数，并将其保存以备后用。现在，即使我的想法在纸上很容易理解，但在阅读代码时却无法理解。即使存在文档字符串，我的上级也发现即使在我在场并提供逐步指导的情况下，也很难遵循该代码。现在我的问题是关于此类代码的文档。一个示例如下，它是一个封闭函数（因此temp是一个内部函数）：
def temp(time, var, ground_truth):
mean = ground_truth(time)
noisy = np.random.normal(mean, var)
return noisy
# ground_truth refers to vector of functions which are to be manipulated
for _ in range(num_points + 1):
new_tuple = list()
for i in range(len(ground_truth)):
partial = functools.partial(temp, var=variances[i], ground_truth=ground_truth[i])
new_tuple.append(partial)
上面的代码获取一个函数列表，并从列表的每个函数中生成一个新函数，该函数是旧函数加上随机生成的正态分布值的总和。
我的问题是关于实现的文档的适当放置和代码的大量想法。将这样的详细文档包含在docstring中是否合适，还是应该专门为实现相关的详细信息创建一个完全独立的文档？如果应该创建单独的文档，最好的方法是什么，是否有一般性准则？
请记住，该软件需要移交给我的上级，他们需要继续开发。