JetBrains PyCharm Community Edition 2018.3
python 3.6.4
windows 7
1、函数命名对函数命名时使用描述性名称,这样大概能从函数名称分辨出函数大概内容,对于一个文档中含有多个函数或者大型项目中非常有用。同时函数命名时只使用小写字母及下划线。
2、多个函数如果程序或者模块包含多个函数,可使用两个空行将相邻的函数分开,这样在视觉上能快速定位函数范围。
3、函数功能描述函数应用注释语句描述其功能,放于函数定义后面并采用文档字符串格式。这样使得其它人在使用该函数时通过阅读注释便能快速了解函数的用途。
4、形参格式形参如有默认值,给形参赋值时等号两边不要有空格,函数调用中的关键字实参也是一样。
5、import语句函数中所有的import语句应放在文件的开头,除了在文件的开头使用了注释来描述整个程序外,此时可将import语句放于注释之后。
6、参数过长如果函数的参数过长,可在函数定义中输入左括号后按回车键,并在下一行按两次Tab键,从而将形参列表和只缩进一层的函数体区分开来。
1、函数命名使用描述性名称,且只使用小写字母及下划线;2、如果程序或者模块包含多个函数,可使用两个空行将相邻的函数分开;3、函数应用注释语句描述其功能,放于函数定义后面并采用文档字符串格式;4、形参如有默认值,赋值时等号两边不要有空格,函数调用中的关键字实参同样;5、所有的import语句应放在文件的开头,除了在文件的开头使用了注释来描述整个程序外;6、参数过长的情况下,可在函数定义中输入左括号后按回车键,并在下一行按两次Tab键,从而将形参列表和只缩进一层的函数体区分开来。
Tips1:不遵循函数编写规范虽不会报错,但在使用中会带来很多不便利。
Tips2:遵循统一的编写规范,使得代码在团队协作的过程中更加高效。