打开APP
userphoto
未登录

开通VIP,畅享免费电子书等14项超值服

开通VIP
灵魂发问:每个程序员心中都有自己的一套编码规范,你的代码别人能看懂吗?

符号

不需要在代码语句执行的末尾添加分号';’,特别是一些其他编程语言的朋友在转写python的时候,就念念不忘的加上这个标志性符号。

命名

1'''
2模块名规范: module_name, 
3包名规范: package_name, 
4类名: ClassName, 
5函数名: method_name
6'''

字符长度

1'''
2每行代码字符长度建议不超过80个
3'''

代码缩进

1'''
2缩进时使用4个空格的长度来进行缩进
3'''

空行

1'''
2顶级定义之间空两行, 方法定义之间空一行
3'''

空格

1'''
2按照标准的排版规范来使用标点两边的空格
3括号内不要有空格
4按照标准的排版规范来使用标点两边的空格
5'''

6# 正确
7print(datas[1],datas[2])
8# 错误
9print(datas[ 1 ],datas[ 2 ])

类的定义规范

 1'''
2类应该在其定义下有一个用于描述该类的文档字符串。如果你的类有公共属性(Attributes),那么文档中应该有一个属性(Attributes)段,并且应该遵守和函数参数相同的格式。
3'''

4class SampleClass(object):
5    """Summary of class here.
6    Longer class information....
7    Longer class information....
8    Attributes:
9        likes_spam: A boolean indicating if we like SPAM or not.
10        eggs: An integer count of the eggs we have laid.
11    """

12    def __init__(self, likes_spam=False):
13        """Inits SampleClass with blah."""
14        self.likes_spam = likes_spam
15        self.eggs = 0

函数定义规范

 1'''
2在函数开始的第一行,标明参数、返回值、函数说明
3'''

4def simaple_func(param):
5    '''
6    示例函数
7    :param param: 参数说明
8    :return: 返回值
9    '''

10    pass

导包规范

 1'''
2导包时每一个包应该独占一行
3'''

4
5# 正确
6import os
7import matplotlib
8
9# 错误
10import os,matplotlib

代码注释

1# 行注释
2'''
3块注释
4'''

本站仅提供存储服务,所有内容均由用户发布,如发现有害或侵权内容,请点击举报
打开APP,阅读全文并永久保存 查看更多类似文章
猜你喜欢
类似文章
【热】打开小程序,算一算2024你的财运
收藏:17个新手常见的Python运行时错误
Python 初学者最容易犯的几个错误
那些年,写 Python 犯过的错误
Python第一章-编码规范
Python函数(一)
Lua代码编写规范
更多类似文章 >>
生活服务
热点新闻
分享 收藏 导长图 关注 下载文章
绑定账号成功
后续可登录账号畅享VIP特权!
如果VIP功能使用有故障,
可点击这里联系客服!

联系客服