
课程咨询: 400-996-5531 / 投诉建议: 400-111-8989
认真做教育 专心促就业
编程开发的规范性是我们在学习编程开发技术的时候需要长期关注的一个问题,今天运城达内培训就给大家简单介绍一下,python编程开发规范都有哪些要求。
1.代码布局规范
代码布局规范主要是指代码的缩进、行宽、空行、换行等方面,下面是一些常见的代码布局规范:
使用四个空格作为一个缩进级别,不要使用制表符。
每行代码多不超过79个字符,如果需要换行可以使用括号、\符号或者三个双引号。
在函数之间、类之间和逻辑块之间添加一行空白行,以提高代码可读性。
2.命名规范
命名规范主要是指变量名、函数名、类名等的命名规则,下面是一些常见的命名规范:
使用全小写的单词或下划线分隔的多个单词来命名变量或函数。
类名字母大写,采用驼峰命名法。
使用前缀或后缀来命名私有变量或函数,以单下划线或双下划线开头或结尾。
3.注释规范
注释规范主要是指如何编写注释,以方便别人理解你的代码,下面是一些常见的注释规范:
在代码中适当添加注释,以解释代码的目的和实现方法。
给函数和类添加文档字符串,以描述其功能和参数等信息。
避免使用无意义的注释,例如“增加变量x的值”。
python的文档字符串是什么?
Python的文档字符串是指在模块、类、方法、函数等代码段的开头使用"""进行多行字符串注释来描述代码段的功能、参数、返回值等信息的规范化方式。这些文档字符串可以被工具程序提取和转换为HTML、PDF、Unix手册页等格式的文档,并且可以被编程编辑器、交互式帮助工具等程序自动读取和显示,对于代码的使用与维护十分有帮助。
文档字符串应该被写在代码段的开头,并包含以下部分:
描述代码段的功能和用途。
描述代码段的参数名称、类型、范围和意义。
描述代码段的返回值类型、范围和意义。
描述代码段的异常和错误处理信息。
其他相关的注释和说明。
注意,文档字符串中的参数类型和异常处理信息只是规范化的描述,实际代码中还需要进行相应的类型判断和错误处理。
4.函数编写规范
函数编写规范主要是指如何编写函数,以方便别人阅读和使用你的代码,下面是一些常见的函数编写规范:
函数应该尽可能短小,不要超过20行。
函数应该只完成一个明确的任务,而不是多个任务。
函数应该有一个明确的返回值,或者返回None。
【免责声明】:本内容转载于网络,转载目的在于传递信息。文章内容为作者个人意见,本平台对文中陈述、观点保持中立,不对所包含内容的准确性、可靠性与完整性提供形式地保证。请读者仅作参考。更多内容请加抖音太原达内IT培训学习了解。