Python:编码风格

约定代码格式有助于让自己的代码易于阅读,让代码易于阅读有助于自己掌握程序是做什么的,也可以帮助他人理解自己编写的代码(编码风格)

需要同时导入标准库中的模块和自己编写的模块时,先编写导入标准库模块的import语句,再添加一个空行,然后编写导入自己编写的模块的import语句。在包含多条import语句的程序中,这种做法让人更容易明白程序使用的各个模块都来自何方(编码风格)

对于每个类,都应紧跟在类定义后面包含一个文档字符串。这种文档字符串简要地描述类的功能,并遵循编写函数的文档字符串时采用的格式约定。每个模块也都应包含一个文档字符串,对其中的类可用于做什么进行描述(编码风格)

每个函数都应包含简要的阐述其功能的注释,该注释应紧跟在函数定义后面,并采用文档字符串格式。文档良好的函数让其他程序员只需阅读文档中的描述就能够使用它:他们完全可以相信代码如描述的那样运行;只要知道函数的名称、需要的实参以及返回值的类型,就能在自己的程序中使用它(编码风格)

类名的驼峰命名法,所谓驼峰命名法,即将类名中的每个单词的首字母都大写,而不使用下划线。实例名和模块名都采用小写格式,并在单词之间加上下划线。当然,所有的这些命名都应该是具有描述性的,因为描述性名称可帮助自己和别人明白代码想要做什么(编码风格)

猜你喜欢

转载自blog.csdn.net/yiminghd2861/article/details/83688484
今日推荐