Python和Django编码风格(PEP)

1 投票
2 回答
1405 浏览
提问于 2025-04-17 05:05

我用Python写代码,使用的是Django框架。最近我看了一些关于编码风格的建议,但遇到了一些模糊的地方。

在Django项目的这个部分 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 上,它说应该这样写:

做那个,返回那个。

那么,哪种写法才是正确的呢?

2 个回答

2

其实没有一个绝对的代码风格规则。每个框架、库和软件都可以根据自己的项目来重新定义一些风格规则。

在我个人的代码中,我更喜欢使用比较通用的代码风格规则(比如官方的Python风格),但你应该在你的文档中说明这一点。

2

PEP 8 是用第一人称单数的方式来写的,而 Django 的文档标准则是用第三人称单数的方式。前者是比较标准的写法。

撰写回答