python函数注释风格的简单介绍
Python 语句和注释
我们将在本节中介绍 Python 语句,缩进以及注释,在本节的最后一部分,还会介绍作为一种特殊类型的 Python 注释 Docstring 。
成都创新互联坚持“要么做到,要么别承诺”的工作理念,服务领域包括:成都做网站、成都网站建设、企业官网、英文网站、手机端网站、网站推广等服务,满足客户于互联网时代的神木网站设计、移动媒体设计的需求,帮助企业找到有效的互联网解决方案。努力成为您成熟可靠的网络建设合作伙伴!
Python 语句是给解释器执行的指令,一条 Python 语句包含类似于如下的表达式,
你可以将 Python 语句堪称解释器解释表达式并将其结果存储在变量中的指令。类似于 for , while , print 之类的语句具有特殊的含义,我们将在在后面的章节中讨论。
当你在一句语句结束时按回车键后,该 Python 语句被终止,我们可称之为单行语句。Python 中的多行语句可以通过使用连续字符 来创建,它将 Python 语句扩展为多行语句。
比如下面的例子,
这可以被称作明确的多行接续。
你还可以使用括号 () ,方括号 [] 或大括号 {} 来进行隐式的多行接续。
例如,你可以使用括号来连接多行语句,
Python 语句块,例如函数,循环或类的主体,以缩进来开头。对于语句块内的每个语句,应该保持相同的缩进。当缩进不一致时,你将得到什么什么 IndentationError 。
一般来说,在
Python 代码样式指南
中建议使用 4 个缩进空格。举例如下,
我们用缩进来增加程序的可读性,比如在下面的程序中,我们用两种方式来完成同一个功能,
你可以在这里看到第一个例子比第二个例子有更好的可读性。
注释用于描述程序的目的或工作工程,注释是在 Python 解释过程中被忽略的行为,它们不会干扰程序的流程。
如果你正在编写数百行代码,肯定需要添加注释,因为其他人在阅读你的代码的时候,没有足够的时间阅读每一行来理解代码的工作。程序的注释增加了可读性,并解释了代码的工作原理。
Python 注释以井号 # 开始
Using hash symbol in each line can define a multi-line comment. But there is another way to add a multi-line comment in Python, that is using triple quotation marks. You can use either ''' or """ .
三重引号 ''' 通常可以用来定义多行文档注释 Docstring ,你也可以用它来作为另外一种在 Python 中添加多行注释的方法。
Docstring 是文档字符串,它通常是 Python 函数,类,模块等的第一条语句。函数,方法和类的描述和注释位于文档字符串(文档字符串)内。
举例如下,
一目了然, Docstring 介绍了函数的功能。
Python命名规则与注释风格
名称不要缩写!!!
名称不要缩写!!!
名称不要缩写!!!
包命名:小写,下划线_连接单词
模块命名:小写,下划线_连接单词
类命名:双驼峰,MyClass
函数命名:小写,下划线_连接单词
全局变量:每个字母大写
注释很重要,要注明函数或类的功能,参数的数据类型、含义等。
注释模板:
注释的作用:
Python有句话是do not repeat yourself,即不要做重复的事,因此出现了类或函数的封装和继承,基于此可提高代码的重复利用性。
在python中如何使用注释
python中的注释有多种,有单行注释,多行注释,批量注释,中文注释也是常用的。
一、python单行注释符号(#):井号(#)常被用作单行注释符号,在代码中使用#时,它右边的任何数据都会被忽略,当做是注释。print 1 #输出1,#号右边的内容在执行的时候是不会被输出的。
二、批量、多行注释符号:在python中也会有注释有很多行的时候,这种情况下就需要批量多行注释符了。多行注释是用三引号''' '''包含的。
python正则表达式的注释方法:学过正则都知道,那简直是天书,为了提高正则的可读性,正则表达式中提供了X(VERBOSE): 详细模式。这个模式下正则表达式可以是多行,忽略空白字符,并可以加入注释。
Python:
是完全面向对象的语言。函数、模块、数字、字符串都是对象。并且完全支持继承、重载、派生、多继承,有益于增强源代码的复用性。Python支持重载运算符和动态类型。
相对于Lisp这种传统的函数式编程语言,Python对函数式设计只提供了有限的支持。有两个标准库(functools, itertools)提供了Haskell和Standard ML中久经考验的函数式程序设计工具。
python注释规范
确保对模块, 函数, 方法和行内注释使用正确的风格
参考:Python风格规范 — Google 开源项目风格指南
文档字符串
模块
函数和方法
Args :
Returns: (或者 Yields: 用于生成器)
Raises:
类
块注释和行注释
网站栏目:python函数注释风格的简单介绍
本文来源:http://ybzwz.com/article/docgiji.html