Python编码与实践:优雅命名与注释指南.pdfVIP

  • 0
  • 0
  • 约小于1千字
  • 约 2页
  • 2026-03-16 发布于北京
  • 举报

Python编码与实践:优雅命名与注释指南.pdf

编程规范

➢注释

1#个人注释

2另一种是docstrings表明如何使用这个包、模块、类、函数(方法),甚至包括使用示

例和单元测试。推荐对每一个包、模块、类、函数(方法)写docstrings。

示例:函数或者类或者模块的doc

➢缩进

Python依赖缩进来确定代码块的层次,行首空白符主要有两种:tab和空格。

如果使用tab缩进,设定tab为4个空格。

➢空行

适当的空行有利于增加代码的可读性,加空行可以参考如下几个准则:

1)在类、函数的定义间加空行;

2)在import不同种类的模块间加空行;

3)在函数中的逻辑段落间加空行,即把相关的代码紧凑写在一起,逻辑段落,

段落间以空行分隔;

➢命名

库:小写一个名词(项目名)

模块:小写,直接连接或者用“_”pythonclasspython_class

module.py

define_module.py

类:驼峰式,首字母大写,不使用下划线连接单词。

classThisIsACl

您可能关注的文档

文档评论(0)

1亿VIP精品文档

相关文档