我使用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说它应该说:
这样做,返回。
那么,哪个选项是真的?
答案 0 :(得分:2)
没有 true 代码样式规则。每个框架,库和软件都可以为自己的项目重新定义一些样式规则。
在我的个人代码中,我更喜欢使用更通用的代码样式规则(在本例中是官方Python代码),但您应该在文档中指定它。
答案 1 :(得分:2)
PEP 8遵循第一人称单数。 Django文档标准遵循第三人称单数。前者是标准的。