python3.7.4关于编码风格的建议

快来打我* 2023-07-13 03:10 46阅读 0赞

文档阅读笔记

python3.7.4关于编码风格的建议

  1. 要写更长,更复杂的Python代码,需要注意一下代码风格。

大多数语言都能以不同的风格 被编写(或更准确地说,被格式化);有些比其他的更具有可读性。

能让其他人轻松阅读你的代码总是一 个好主意,采用一种好的编码风格对此有很大帮助。

对于Python,PEP8已经成为大多数项目所遵循的风格指南;它促进了一种非常易读且令人赏心悦目的 编码风格。

每个Python开发人员都应该在某个时候阅读它;以下是为你提取的最重要的几个要点:

• 使用4个空格缩进,不要使用制表符。 4个空格是一个在小缩进(允许更大的嵌套深度)和大缩进(更容易阅读)的一种很好的折中方案。 制表符会引入混乱,最好不要使用它。

• 换行,使一行不超过79个字符。 这有助于使用小型显示器的用户,并且可以在较大的显示器上并排放置多个代码文件。

• 使用空行分隔函数和类,以及函数内的较大的代码块。

• 如果可能,把注释放到单独的一行。

• 使用文档字符串。

•Imports

  • Imports should usually be on separate lines:

    1. Yes: import os
    2. import sys
    3. No: import sys, os 不要在同一行.

• 在运算符前后和逗号后使用空格,但不能直接在括号内使用:a = f(1, 2) + g(3, 4)。

•在冒号:分号;逗号,之前,最好不要用空格.(参考https://www.python.org/dev/peps/pep-0008/#id33),尽量少用空格,特别是容易造成意思混乱的情况下.

• 以一致的规则为你的类和函数命名;按照惯例应使用 UpperCamelCase 来命名类,而以 lowercase_with_underscores 来命名函数和方法。始终应使用 self 来命名第一个方法 参数(有关类和方法的更多信息请参阅初探类)。

• 如果你的代码旨在用于国际环境,请不要使用花哨的编码。Python默认的UTF-8或者纯ASCII在 任何情况下都能有最好的表现。

• 同样,哪怕只有很小的可能,遇到说不同语言的人阅读或维护代码,也不要在标识符中使用非 ASCII字符。

发表评论

表情:
评论列表 (有 0 条评论,46人围观)

还没有评论,来说两句吧...

相关阅读

    相关 KALDI编码风格

    Kaldi编码风格 当开始编写Kaldi工具包的最终版本时,我们决定使用OpenFst作为C ++库。 为了与OpenFst保持一致,我们决定在大多数方面使用相同的编码风格