Skip to main content
 首页 » 编程设计

Python 样式 : should I avoid commenting my import statements

2025年05月04日10xing901022

我会尽量将其设为封闭式问题:

我经常发现我有一组导入,就像一堆数学导入;但稍后我可能会删除或将使用这些导入项目的代码部分移动到另一个文件。问题是我经常忘记我为什么要使用特定的导入(例如,我经常使用 Counter 类,或者 itertools 中的随机东西。)因此我可能希望有注释来指定我的导入的目的;这样,如果我不再需要它们,我可以删除整个 block 。

在我的导入语句中添加注释是否被认为是不好的风格?

请您参考如下方法:

嗯,python 的美妙之处在于它是(或应该是)显式的。在这种情况下,只要您不执行 * 导入(这被认为是不好的做法),您就会知道是否仅通过对命名空间执行 grep 来引用导入。然后你就会知道是否可以删除它。

请允许我也对其他答案添加一个对比。 “太多”评论确实是不好的做法。您不应该在代码中添加多余的注释,因为代码的功能显而易见。此外,必须维护注释,就像代码一样。如果您创建了过多的评论,那么您就是在为自己做更多的工作。