Python类和方法注释规范说明
目录
- Python类和方法注释规范
- 注释风格
- 小技巧
- 代码规范（含代码注释）
- 代码缩进和冒号
- 空行分隔代码段
- 包、模块的命名规范
- 类和对象的命名规范
- 函数的命名规范
- 代码注释
Python类和方法注释规范
注释风格
def func(path, field_storage, temporary):
'''基本描述
详细描述
:param path: The path of the file to wrap
:type path: str
:param field_storage: The :class:`FileStorage` instance to wrap
:type field_storage: FileStorage
:param temporary: Whether or not to delete the file when the File instance is destructed
:type temporary: bool
:returns: A buffered writable file descriptor
:rtype: BufferedFileStorage
'''
pass
def func(path, field_storage, temporary):
'''基本描述
详细描述
Parameters
----------
path : str
The path of the file to wrap
field_storage : FileStorage
The :class:`FileStorage` instance to wrap
temporary : bool
Whether or not to delete the file when the File instance is destructed
Returns
-------
BufferedFileStorage
A buffered writable file descriptor
'''
pass
Google（官方推荐）
def func(path, field_storage, temporary):
'''基本描述
详细描述
Args:
path (str): The path of the file to wrap
field_storage (FileStorage): The :class:`FileStorage` instance to wrap
temporary (bool): Whether or not to delete the file when the File instance is destructed
Returns:
BufferedFileStorage: A buffered writable file descriptor
'''
pass
| 风格 | 特点 | 适用 |
|---|---|---|
| reStructuredText | 用冒号分隔 | PyCharm默认 |
| NumPy | 用下划线分隔 | 倾向垂直，长而深的文档 |
| 用缩进分隔 | 倾向水平，短而简单的文档 |
Sphinx对NumPy和Google风格的对比，英文不好可以参考中文版
小技巧
在PyCharm中Ctrl+Q可快速查看注释
代码规范（含代码注释）
代码缩进和冒号
注意条件语句必须严格控制缩进，保证父句和子句的关系
num = 10
if num>5:
print('yes')
else:
print('no')
空行分隔代码段
例如if语句判断、while循环、for循环、def函数、class类等代码段前后最好留一行（人工分好段落）
# if语句
if num>5:
print('yes')
else:
print('no')
# for循环
for i in (1,2,4):
print(i)
# while循环
while i>3:
print('yes')
i+=1
else:
print('end')
# 函数定义
def show():
print(132)
# 类定义
class Person:
def show(self):
print(123)
包、模块的命名规范
1. 包——要求统一用小写（相当于文件夹）
2.模块——要求统一用小写（相当于文件夹里的文件）
类和对象的命名规范
1. 类——严格的驼峰式写法eg.IndexUserPerson
2. 对象——要求统一用小写
函数的命名规范
驼峰式写法 eg.indexUserPerson（不强行）
代码注释
1.单行注释——#
2.多行注释——（快捷键为Ctrl+/）
'''
三对单引号，python多行注释符'''
以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。
相关推荐
-
python两种注释用法的示例
注释 标注解释,目的是帮助读者理解的文本 也就是说,注释首先是文本,其二是说明,其三是思路,其四是例子 注释有两种形式 1. # ... 单行注释 用于对某句语句或语句块进行解释 放在语句块的头行或一个语句的尾部 def see_seq(iterable): # 序列开始的下标为 0,也就是索引为 0 # 序列第一个元素的下标是0,也就是第n个元素的下标为 len(iterable) - 1 # for 循环自动处理索引.索引边界 # 自动依次取出 0 到 len(iterable)-1 索引对
-
Python代码注释规范代码实例解析
一.代码注释介绍 注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码. 注释是编写程序时,写程序的人给一个语句.程序段.函数等的解释或提示,能提高程序代码的可读性. 在有处理逻辑的代码中,源程序有效注释量必须在20%以上. 二.代码注释分类 行注释:在符号后那一行不会被编译(显示) 块注释:被块注释符号中间的部分不会被编译 三.python代码注释基础 Python中使用#表示单行注释.单行注释可以作为单独的一行放在被注释代码行之上,也可以放在语句或表达式之后.如下例子: name
-
Python中注释（多行注释和单行注释）的用法实例
前言 学会向程序中添加必要的注释,也是很重要的.注释不仅可以用来解释程序某些部分的作用和功能(用自然语言描述代码的功能),在必要时,还可以将代码临时移除,是调试程序的好帮手. 当然,添加注释的最大作用还是提高程序的可读性!很多时候,笔者宁愿自己写一个应用,也不愿意去改进别人的代码,没有合理的注释是一个重要原因.虽然良好的代码可自成文挡,但我们永远也不清楚今后读这段代码的人是谁,他是否和你有相同的思路.或者一段时间以后,你自己也不清楚当时写这段代码的目的了. 总的来说,一旦程序中注释掉某部分内容,
-
这样写python注释让代码更加的优雅
python这样注释,让你的代码看起来更加的优雅,是不是常常感觉自己的python代码写出来,看起来特别的乱,虽然可以正常运行,但是在优雅性上似乎欠缺的很多,这篇文章主要教你,如何让你的python代码看起来更加的优雅与美观, 一.注释欣赏 这里有一段飞兔小哥哥自己常写的注释模版 这里主要分为表头注释.类注释.欢迎语以及方法注释 表头注释会标注这个项目的名称.文件名.项目作者.时间等基础信息 类注释会标注这个类主要用来做什么的 而方法注释则表示当前方法的作用 #!/usr/bin/env p
-
Python类和方法注释规范说明
目录 Python类和方法注释规范 注释风格 小技巧 代码规范(含代码注释) 代码缩进和冒号 空行分隔代码段 包.模块的命名规范 类和对象的命名规范 函数的命名规范 代码注释 Python类和方法注释规范 注释风格 reStructuredText(PyCharm默认) def func(path, field_storage, temporary): '''基本描述 详细描述 :param path: The path of the file to wrap :type path: str :
-
IDEA类和方法注释模板设置（非常详细）
idea 模版之自定义类与方法注释 很多公司都有要求的代码注释规范,我们每新建类或者方法的时候从新复制粘贴很麻烦,而且容易粘错. 当然自定义模板还可以用到很多地方,比如系统自带的 sout就是system.out.print(); 当你输入某文本的时候,系统会自动替换成目标文本. 1定义java文件头部的注释 2给java类中的方法添加上注释 2.1第一步勾选Enable Live Templates 2.2第二步新建一个Group 2.3第三步新建一个Template 2.4第四步点击Def
-
python类的方法属性与方法属性的动态绑定代码详解
动态语言与静态语言有很多不同,最大的特性之一就是可以实现动态的对类和实例进行修改,在Python中,我们创建了一个类后可以对实例和类绑定心的方法或者属性,实现动态绑定. 最近在学习python,纯粹是自己的兴趣爱好,然而并没有系统地看python编程书籍,觉得上面描述过于繁琐,在网站找了一些学习的网站,发现廖雪峰老师的网站上面的学习资源很不错,而且言简意赅,提取了一些python中的重要的语法和案例.重要的是可以在线测试python的运行代码,缺点就是没有系统的看python的书籍,不能及时的将
-
IDEA2020.3.2版本自动注释类和方法注释模板配置步骤详解
想来大家在学习或者开发的环境下经常要自己注解类和方法吧:下面我来为大家讲解怎么创建自己的注解模板: 一.配置类自动注解 1.打开idea file–>Settings–> 2.按照下图的步骤:直接搜索file and code–>导航栏点击File and Code Templates–>点击files文件类型–>然后选择Class文件模板在里面编辑自己想要的模板–>点击apply应用一下–>点击ok.如果还要设置方法模板的话先别急着点ok. 类注解代码片:根据自
-
IDEA类与方法注释模板设置图文教程(非常详细)
目录 一.概述 二.类注释模板 1.File-->settings-->Editor-->File and Code Templates-->Files 三.方法注释模板 1.创建模板 2.设置模板内容-IDEA格式模板 3.设置模板应用场景 4.设置参数 5.JavaDoc格式 总结 一.概述 IDEA自带的注释模板一般都很简单,然而我们在写代码的时候喜欢把类注释和文档注释写在代码里,既方便自己看所有的参数,也便于以后维护代码的时候看到编码作者.下面是我的代码注释,我们就按照这种
-
Python类绑定方法及非绑定方法实例解析
一.绑定方法 1.对象的绑定方法 首先我们明确一个知识点,凡是类中的方法或函数,默认情况下都是绑定给对象使用的.下面,我们通过实例,来慢慢解析绑定方法的应用. class People: def __init__(self,name,age): self.name = name self.age = age def talk(self): pass p = People('xiaohua',18) print(p.talk) 输出结果: <bound method People.talk of
-
Python类中方法getitem和getattr详解
1.getitem 方法 使用这个方法最大的印象就是调用对象的属性可以像字典取值一样使用中括号['key'] 使用中括号对对象中的属性进行取值.赋值或者删除时,会自动触发对应的__getitem__.__setitem__.__delitem__方法 代码如下: class Foo(object): def __init__(self): self.name = 'jack' def __getitem__(self,item): if item in self.__dict__: # item
-
举例讲解Python面相对象编程中对象的属性与类的方法
python 对象的属性 进入正题,来看一个实例来了解python中类,对象中公有属性,私有属性及局部变量,全局变量的区别. root@10.1.6.200:~# cat object.py #!/usr/bin/env python #coding:utf8 class Dave(): var1 = "class atribute,public atrribute var1" #类属性,公有属性var1 __var2 = "class self atribute __var
-
Python创建类的方法及成员访问的相关知识总结
一.创建类的方法与成员访问 1.1 创建实例方法并访问 实例方法是指在类中定义的函数.该函数是一种在类的实例上操作的函数. 同__init__()方法一样,实例方法的第一个参数必须是self,并且必须包含一个self参数. 1.2 创建数据成员(属性)并访问 数据成员是指在类中定义的变量,即属性(对象的特征).根据定义位置,属性(成员变量) 有两种:一种是实例属性,另一种是类属性(类变量). 1.2.1 添加与访问方式 类属性的添加与访问方式同对象属性,只是把self关键字换成类名 1.2.1.
-
python访问类中docstring注释的实现方法
本文实例讲述了python访问类中docstring注释的实现方法.分享给大家供大家参考.具体分析如下: python的类注释是可以通过代码访问的,这样非常利于书写说明文档 class Foo: pass class Bar: """Representation of a Bar""" pass assert Foo.__doc__ == None assert Bar.__doc__ == "Representation of a B