Python 命名规范「建议收藏」

Python 命名规范「建议收藏」1.规范1.变量名区分大小写;2.严禁使用关键字作为变量名;3.确定自己的命名风格,不可随意变换;4.命名应该科学严谨,切勿太长或者表达比较模糊;5.命名中若使用特殊约定或缩写,则要有注释说明;6.尽量不要使用中文字符和纯数学字符,避免编码错误;7.名字由英文字母、数字、下划线组成,如abc,abc13和_abc等;8.要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写;9.同一软件产品内,应规划好接口部分(变量、结构、函数及常量)的命名,防止编译、链接时产生冲突。

1. 规范

1.变量名区分大小写;

2.严禁使用关键字作为变量名;

3.确定自己的命名风格,不可随意变换;

4.命名应该科学严谨,切勿太长或者表达比较模糊;

5.命名中若使用特殊约定或缩写,则要有注释说明;

6.尽量不要使用中文字符和纯数学字符,避免编码错误;

7.名字由英文字母、数字、下划线组成,如abc,abc13和_abc等;

8.要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写;

9.同一软件产品内,应规划好接口部分(变量、结构、函数及常量)的命名,防止编译、链接时产生冲突。

2. 参考

类型 公有/外部成员 私有/内部成员
模块(module) my_naming_convention _my_naming_convention
包(package) my_naming_convention
类(class) MyNamingConvention _MyNamingConvention
异常(Exception) MyNamingConvention
函数(function) my_naming_convention() _my_naming_convention()
全局/类常量(constant) MY_NAMING_CONVENTION _MY_NAMING_CONVENTION
全局/类变量(variable) my_naming_convention _my_naming_convention

3. 缩写

  • 命名应当尽量使用全拼写的单词,缩写的情况有如下两种:
  1. 常用的缩写,如XML、ID等,在命名时也应只大写首字母,如XmlParser。

  2. 命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式。

  • 例如:

    function 缩写为 fn

    text 缩写为 txt

    object 缩写为 obj

    count 缩写为 cnt

    number 缩写为 num

4. 前导后缀下划线

  • 一个前导下划线:表示非公有。

  • 一个后缀下划线:避免关键字冲突。

  • 两个前导下划线:当命名一个类属性引起名称冲突时使用。

  • 两个前导和后缀下划线:“魔”(有特殊用图)对象或者属性,例如__init__或者__file__。绝对不要创造这样的名字,而只是使用它们。

    注意:关于下划线的使用存在一些争议。

5. 应该避免的名称

  1. 单字母名称, 除了计数器和迭代器.
  2. 包/模块名中的连字符(-)
  3. 双下划线开头并结尾的名称(Python 保留, 例如__init__)
架构君码字不易,如需转载,请注明出处:https://javajgs.com/archives/211934
0

发表评论