Coding style 记录谁调用函数

在函数上方使用注释来记录调用函数的人是不是很糟糕

例如：

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

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

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

明显的缺点：这是需要维护的。如果

bar

被

foo

以外的对象调用，或者

foo

被重命名，或者诸如此类，文档要么需要更改，要么会变得非常混乱*

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

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

---

好了。权衡明显的有利因素和明显的不利因素，努力做出一个好的决定。

首先，这不应该是一个问题。因此不鼓励讨论导向的问题。要回答这个问题，这实际上取决于个人的看法。对我来说，对这样一个函数进行注释听起来很好，实际上这是一个很好的实践，但只有当该函数由一个函数调用时，您的注释可能会随着时间的推移变得过时并产生误导。请看，MohitC警告过的讨论：-）@MohitC在某些语言中，嵌套函数是合法的，因此如果一个函数只被一个函数使用过，那么最好只嵌套它。但我同意你的第一句话，这可能是程序员的问题。@user2085282这个问题将被否决，并以程序员的“主要观点”结束。请阅读：。@kjschiroo不要重复发布，如果它被标记为这样，它将被一个mod移动。