在 Plone 上命名我的发行版的最佳方式?
我在 Company
工作,创建实现功能的项目 Project
。我们将其命名为Newsletter
。它可以用于进一步的项目。
我需要创建一个新的 Plone 产品,但我不知道最好的方法。我想到了company.project.newsletter。我读过某处(@aclark回答 记得链接)不要在我的产品名称中使用嵌套命名空间“除非我 100% 确定我正在做的事情”。
有人可以指导我一些关于正确命名我的 Plone 包的参考吗?我怀念像 pep8 这样有一些约定的指南。 (特别是当有对此有完全不同的看法)。
I work at Company
, creating project Project
that implements a functionality. Let's name it Newsletter
. It could be used in further projects.
I need to create a new Plone Product, but I don't know the best way to do it. I thought about company.project.newsletter
. I've read somewhere (@aclark answer remembered the link) to not use nested namespaces in my product name "unless I'm 100% certain in what I'm doing".
Can someone guide me with some references about properly naming my Plone packages? I miss a guide like pep8 with some convention. (Specially when there are completely different opinions about this).
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
一般来说,您询问的是约定(而不是技术问题)。简而言之,没关系。我更喜欢扁平或短的命名空间,但它们可以任意长,例如 https://github.com/aclark4life/viewlets_dont_suck 。
对于嵌套命名空间,例如 plone.* 和 plone.app.*,该约定有意义。 plone.* 理想情况下能够在 Plone 中重用,而 plone.app.* 包只能在 Plone 中使用。
同样,公司品牌命名空间也很常见。就您而言,我可能会选择company.newsletter。
请参阅:http://www.martinaspeli.net/articles/the- Naming-of-things-package-names-and-namespaces 了解更多信息。
Generally speaking, you are asking about a convention (versus something technical). In short, it doesn't matter. I prefer flat or short namespaces, but they can be as long as you like e.g. https://github.com/aclark4life/viewlets_dont_suck.
In the case of nested namespaces, e.g. plone.*, and plone.app.* the convention has meaning. plone.* are ideally able to be reused out of Plone, whereas plone.app.* packages can only be used in Plone.
Similarly, it's quite common to see company branded namespaces. In your case, I'd probably go with company.newsletter.
See: http://www.martinaspeli.net/articles/the-naming-of-things-package-names-and-namespaces for more information.