记录函数调用者

Documenting who a function is called by

在函数上方使用注释来记录调用函数的人是否是一种不良风格？

举个例子：

# Called by foo
def bar(something):
    return something+1

我觉得这是不好的做法，但我想在四处告诉别人不要这样做之前先检查一下自己。

不好的风格，好的风格——太主观了。但也有一些明显的优点和缺点。

明显的缺点：这是需要维护的东西。如果 bar 被 foo 以外的其他东西调用，或者 foo 被重命名，或者类似的事情，文档要么需要更改，要么会变得非常混乱*。

* 当然，如果您绝对确定这不会发生，这没什么大不了的。

明显的优点：它向人们展示了这个函数的调用者。这可能是也可能不是有用的信息。它可能与您使用的工具多余，也可能不多余。

好了。权衡利弊，做出正确的决定。