Python 风格:我应该避免注释导入语句吗?

3 投票
5 回答
2371 浏览
提问于 2025-04-17 02:57

我会尽量把这个问题说得简单明了:

我发现自己经常有一堆一起用的导入,比如一些数学相关的库;但后来我可能会把用到这些导入的代码部分删掉或者移动到其他文件里。问题是,我常常忘记为什么要用某个特定的导入(比如,我经常用到Counter类,或者itertools里的随机函数)。所以我想在导入的地方加上注释,说明这些导入是干什么用的;这样如果我不再需要它们,就可以直接删掉整块代码。

在导入语句里加注释算不算不好的写法呢?

5 个回答

3

这并不是坏习惯。其实,注释越多越好。通过记录你使用某些导入的原因,可以让看你代码的人明白你为什么这样做,也许他们会理解你的思路,甚至想出更好的方法来解决问题。

所以,你不应该害怕给你的代码加上合适的注释。

5

注释的作用是帮助解释或提醒。如果对你有帮助,就可以使用它们。此外,像 pylint 这样的工具可以帮助你发现不必要的导入,以及其他很多问题。

12

Python的一个好处就是它很明确,或者说应该是这样。在这种情况下,只要你不使用*导入(这被认为是不好的做法),你就可以通过搜索命名空间来知道某个导入是否被引用。这样你就能判断是否可以删除它。

我还想补充一点,针对其他回答的反面观点。评论写得“太多”确实可能是不好的做法。你不应该在那些功能显而易见的代码上添加多余的评论。此外,评论和代码一样,都需要维护。如果你写了过多的评论,那就相当于给自己增加了很多工作量。

撰写回答