【问题标题】:Naming Conventions for Methods / Classes / Packages方法/类/包的命名约定
【发布时间】:2009-11-17 14:24:36
【问题描述】:
您对日常代码使用什么命名约定?我正在考虑这个问题,因为我目前有一个 Python 项目,其中包含 3 个包,每个包都有独特的用途。现在,我已经将通用的“实用程序”方法放入我为项目创建的第一个包中,但是我正在考虑将这些方法移到单独的包中。问题是我会怎么称呼它?实用、收藏、分类?
您是否有任何标准的命名约定,如果有,请提供链接?我知道每种语言都有自己的命名约定,但是有没有你认为最有用的特定的一种,你会推荐我开始使用?
【问题讨论】:
标签:
python
naming-conventions
【解决方案1】:
一般来说,您应该遵循所用语言的命名约定。您是否喜欢或喜欢另一种语言的标准并不重要。语言上下文中的一致性有助于使您的代码更具可读性、可维护性和其他人可用。在 Python 中,这意味着您使用 PEP 8。
举个例子:
在 Python 中,我将包称为“utils”——或者如果我打算重新分发,则称为“coryutils”或类似的东西以避免命名空间冲突。
在 Java 或 ActionScript 中,我将包称为“net.petosky.utils”,无论我是否打算重新分发。
【解决方案2】:
除非您有充分的理由不这样做,否则您应该遵循PEP 8 中提供的指南。请特别参阅“规范性:命名约定”。