调用者和被调用者结构中的参数文档

时间:2018-03-17 13:18:52

标签: documentation

考虑以下情况:
一个库包含一个调用多个被调用函数的调用函数,并且不执行任何操作。

def caller(a, b):
    callee1(a)
    callee2(b)

def calle1(a):
    ...

def calle2(b):
    ...

并且假设用户有时可能使用呼叫者功能
有时只使用其中一个被调用函数

我想记录这些功能 我认为这样做的选项如下:

选项1
记录来电者和被叫者 优点:用户将拥有一个记录良好的API,无论他是否想使用调用函数或被调用函数
缺点:参数的文档是重复的,这可能导致错误并需要更多的维护。

选项2
记录来电者或被叫者 专业人士:没有文件重复。
缺点:如果用户希望使用未记录的函数

,则用户将没有记录良好的API

正如我所看到的,这两个选项都有我想避免的后果。

所以我的问题是: 有没有更好的方法来记录这个?
或者是否有更好的方法来构建此代码以避免这些后果?

0 个答案:

没有答案