您的位置:首页 > 绯闻

Python的代码书写规范、代码注释规范、代码命名规范详解

时间:2019-08-24
钱柜pt娱乐场

22: 17: 42 White Jade Creative

71340db39c232954781f6980a20d75d9.jpeg

代码编写规范

压痕

使用4个空格进行缩进,不要将制表符和空格混合缩进,也不要单独使用Tab Tab。对于行连接的情况,换行符的元素可以垂直对齐。

49cc7d7a9173076ace6341bb3cb5dddc.jpeg

线宽

每行代码的大小不应超过80个字符,在特殊情况下,它可能略大于80个,例如长导入模块语句或注释中的URL。

Python隐式连接括号,括号和花括号中的行。您可以通过在表达式周围添加一对额外的括号而不使用反斜杠来连接线来利用此功能。

件太多而且它在一行上太长,则可以使用括号来实现隐式连接,如下所示:

241d642cf83ec0590f722e168ddf7034.jpeg

如果一行上的文本字符串太长,您可以使用括号来实现隐式行连接,如下所示:

682f127296b29d28a591dad399badda1.jpeg

引号

自然语言使用双引号,机器标签使用单引号,因此大多数代码应使用单引号。

自然语言使用双引号

b9f001877496afd265087378682f2e1e.jpeg

使用单引号识别机器

a940a2ef3b2383d0b7402f51aacad6e1.jpeg

正则表达式使用双引号

7e0d9bddc353c5993090f0838085ce4c.jpeg

文档字符串(Docstring)使用三个双引号

4b2f73b5a0b744f25c86d70b065c3299.jpeg

空行

类定义和模块中的函数之间有两行。类中的每个函数之间都有一个空行。该函数可以使用空行来分隔每个逻辑代码块,使其更清晰。

934a7f1c240e6d5d80b4870c7feff6d7.jpeg

模块导入

每个独立模块导入应该在一个单独的行上。导入代码应放在文件的顶部,放在模块描述之后,文档字符串,全局变量和常量之前,以及按照以下顺序推荐模块导入建议顺序,每个组之间使用一个空格。线分离:

标准库导入第三方库导入自定义库导入

ad40edf59ccec2c2000a25ce9f54fa01.jpeg

同时,导入模块应该尝试使用绝对导入。

e0168486fddb66fbb1b5548c9a2b4a1b.jpeg

空间

在二元运算符的两边添加一个空格,例如=,==,<>=,<><=,>=,in,not in,is,is no,而且,或者,不是。需要注意的是,当'='用于表示关键字参数或默认参数值时,请勿在任何一侧使用空格。

deb9d7d0b422624a4290453dee209e3a.jpeg

在函数的参数列表中的“,”之后必须有空格,但在左括号之后,不要在右括号之前添加额外的空格。

0d9c21a3f28bdaf2fd16f87bd80c8813.jpeg

dc9996306a432d12699c1d4196aac738.jpeg

代码注释规范

阻止评论

在“#”是空格后,段落需要用空行分隔。

8997a8a0afa4da7ea7089c7bc0f25985.jpeg

行评论

行注释至少由两个空格和语句分隔。

429d894d10c34863b2e71d2e44e391fc.jpeg

文档说明文档字符串文档字符串

Docstrings作为文档通常出现在模块,函数和类的头部。 Python可以从对象的__doc__属性中获取文档字符串。 Python中的模块,类,函数,方法和生成器应该尝试编写文档字符串。可能无法写入外部不可见的私有方法,但应在def之后提供块注释描述。文档注释以'''''开头和结尾,第一行不包装,如果有多行,则必须包装最后一行。

61527b54f22054a6b26e7dba9c943679.jpeg

有关函数的注释,建议按如下方式引用以下注释规范:

c7ce8b3a27ca42be88425cb38c3b590b.jpeg

69d43eb0b4c1acf0567c80ce68bad9c9.jpeg

代码命名约定

模块命名

模块以小写字母命名,第一个字母保持小写,因此尽量不要加下划线。

5bd9b7cb5221cfaf01dec3d763dab193.jpeg

班级名称命名

类名使用驼峰命名样式,首字母大写。

a6c9691c6eafa4abaf0ef73ec169daa4.jpeg

功能命名

函数名称均为小写字母。如果有多个单词,则用下划线分隔。

62c63cb8a0fbd174beaa7ba40e85ee83.jpeg

变量命名

变量名称应尽可能使用小写字母。常量应为全大写字母。如果有多个单词,则应使用下划线分隔。

69ef6dc583f06dc1272ef6cd122e200b.jpeg

71340db39c232954781f6980a20d75d9.jpeg

代码编写规范

压痕

使用4个空格进行缩进,不要将制表符和空格混合缩进,也不要单独使用Tab Tab。对于行连接的情况,换行符的元素可以垂直对齐。

49cc7d7a9173076ace6341bb3cb5dddc.jpeg

线宽

每行代码的大小不应超过80个字符,在特殊情况下,它可能略大于80个,例如长导入模块语句或注释中的URL。

Python隐式连接括号,括号和花括号中的行。您可以通过在表达式周围添加一对额外的括号而不使用反斜杠来连接线来利用此功能。

件太多而且它在一行上太长,则可以使用括号来实现隐式连接,如下所示:

241d642cf83ec0590f722e168ddf7034.jpeg

如果一行上的文本字符串太长,您可以使用括号来实现隐式行连接,如下所示:

682f127296b29d28a591dad399badda1.jpeg

引号

自然语言使用双引号,机器标签使用单引号,因此大多数代码应使用单引号。

自然语言使用双引号

b9f001877496afd265087378682f2e1e.jpeg

使用单引号识别机器

a940a2ef3b2383d0b7402f51aacad6e1.jpeg

正则表达式使用双引号

7e0d9bddc353c5993090f0838085ce4c.jpeg

文档字符串(Docstring)使用三个双引号

4b2f73b5a0b744f25c86d70b065c3299.jpeg

空行

类定义和模块中的函数之间有两行。类中的每个函数之间都有一个空行。该函数可以使用空行来分隔每个逻辑代码块,使其更清晰。

934a7f1c240e6d5d80b4870c7feff6d7.jpeg

模块导入

每个独立模块导入应该在一个单独的行上。导入代码应放在文件的顶部,放在模块描述之后,文档字符串,全局变量和常量之前,以及按照以下顺序推荐模块导入建议顺序,每个组之间使用一个空格。线分离:

标准库导入第三方库导入自定义库导入

ad40edf59ccec2c2000a25ce9f54fa01.jpeg

同时,导入模块应该尝试使用绝对导入。

e0168486fddb66fbb1b5548c9a2b4a1b.jpeg

空间

在二元运算符的两边添加一个空格,例如=,==,<>=,<><=,>=,in,not in,is,is no,而且,或者,不是。需要注意的是,当'='用于表示关键字参数或默认参数值时,请勿在任何一侧使用空格。

deb9d7d0b422624a4290453dee209e3a.jpeg

在函数的参数列表中的“,”之后必须有空格,但在左括号之后,不要在右括号之前添加额外的空格。

0d9c21a3f28bdaf2fd16f87bd80c8813.jpeg

dc9996306a432d12699c1d4196aac738.jpeg

代码注释规范

阻止评论

在“#”是空格后,段落需要用空行分隔。

8997a8a0afa4da7ea7089c7bc0f25985.jpeg

行评论

行注释至少由两个空格和语句分隔。

429d894d10c34863b2e71d2e44e391fc.jpeg

文档说明文档字符串文档字符串

Docstrings作为文档通常出现在模块,函数和类的头部。 Python可以从对象的__doc__属性中获取文档字符串。 Python中的模块,类,函数,方法和生成器应该尝试编写文档字符串。可能无法写入外部不可见的私有方法,但应在def之后提供块注释描述。文档注释以'''''开头和结尾,第一行不包装,如果有多行,则必须包装最后一行。

61527b54f22054a6b26e7dba9c943679.jpeg

有关函数的注释,建议按如下方式引用以下注释规范:

c7ce8b3a27ca42be88425cb38c3b590b.jpeg

69d43eb0b4c1acf0567c80ce68bad9c9.jpeg

代码命名约定

模块命名

模块以小写字母命名,第一个字母保持小写,因此尽量不要加下划线。

5bd9b7cb5221cfaf01dec3d763dab193.jpeg

班级名称命名

类名使用驼峰命名样式,首字母大写。

a6c9691c6eafa4abaf0ef73ec169daa4.jpeg

功能命名

函数名称均为小写字母。如果有多个单词,则用下划线分隔。

62c63cb8a0fbd174beaa7ba40e85ee83.jpeg

变量命名

变量名称应尽可能使用小写字母。常量应为全大写字母。如果有多个单词,则应使用下划线分隔。

69ef6dc583f06dc1272ef6cd122e200b.jpeg

  • 友情链接:
  • 钱柜娱乐999官网 版权所有© www.imexdelta.com 技术支持:钱柜娱乐999官网| 网站地图