跟着大大学python(32)

import module_name


module_name
from module_name import function_name
from module_name import function_name as fn
import module_name as mn

8.7 函数编写指南

编写函数时,需要牢记几个细节。应给函数指定描述性名称,且只在其中使用小写字母和下划线。描述性名称可以帮助你和别人明白代码想要什么。给模块命名时也要遵循上述约定。

每个函数都应该包含简要地阐述其功能的注释,该注释应该紧跟在函数定义后面,并采用文档字符串格式。文档良好的函数让其他程序员只需阅读文档字符串中的描述就能够使用它。

给形参指定默认值时,等号两边不要有空格:

def function_name(parameter_0, parameter_1='default value')

对于函数调用中的关键字实参,也应该遵守这种约定:

function_name(value_0, parameter_1='value')

PEP8建议代码行的长度不要超过79字符。如果形参很多,导致溢出,可在函数定义中输入左括号(后按回车enter,并在下一行按两次Tab键,从而将形参列表和只缩进一层的函数区分开来。

大多数编辑器都会自动对齐后续参数列表行,使其缩进程度与你给第一个参数列表行指定的缩进程度相同:

def function_name(

                 parameter_0, parameter_1, parameter_2,

                 parameter_3, parameter_4):

function body...

如果程序或模块包含多个函数,可使用两个空行将相邻的函数分开,这样将更容易直到前一个函数在什么地方结束,下一个函数从什么地方开始。

所有的import语句都应放在文件开头,唯一例外的是,在文件开头使用了注释来描述整个程序。

这些很关键,不仅要会写代码,而且要让你的代码让别人看得懂。这是作为程序员的基本素质!!!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容