Python 和 Django 编码风格 (PEP)

发布于 2024-12-12 07:20:07 字数 630 浏览 0 评论 0原文

我使用 Django 框架使用 Python 编写代码。 现在我已经阅读了所有这些编码风格建议,但遇到了一些模糊的事情。

在 djangoproject 部分中 https:// docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#python-style 它说函数注释应该这样写:

这样做,返回该结果。

但是,这里 http://www.python.org/dev /peps/pep-0257/#one-line-docstrings 它说应该这样说:

这样做,返回。

那么,哪个选项是正确的呢?

I write code with Python using Django framework.
Now I have read about all these coding style advices, but encountered a vague thing.

In djangoproject section here https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/#python-style it says that function comments should say like:

Does that, returns that.

However, here http://www.python.org/dev/peps/pep-0257/#one-line-docstrings it says that it should say like:

Do that, return that.

So, which option is true?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

萌︼了一个春 2024-12-19 07:20:07

PEP 8 采用第一人称单数。 Django 文档标准遵循第三人称单数。前一种是标准的。

PEP 8 follows the first person singular. Django documentation standard follows the third person singular. The former one is standard.

执笔绘流年 2024-12-19 07:20:07

不存在真正的代码样式规则。每个框架、库和软件都可以为自己的项目重新定义一些样式规则。

在我的个人代码中,我更喜欢使用更通用的代码样式规则(在本例中为官方 Python 规则),但您应该在文档中指定这一点。

There is no true code style rule. Every framework, library and software can redefine some style rule for its own project.

In my personal code I prefer to use the more general code style rule (in this case the official Python one) but you should specify this in your documentation.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文