Python的注释方法有几种?请详细说明每种方法,python 方法注释

　　本文主要介绍Python类和方法注释的规范，有很好的参考价值。希望对大家有帮助。如有错误或不足之处，请不吝赐教。

目录

Python类和方法注释规范

注释风格

　　ReStructuredText(PyCharm默认)

　　def func(path，field_storage，temporary):

　　的基本描述

　　扩展

　　:param path:要换行的文件的路径

　　:类型路径：字符串

　　:param field_storage:要包装的：class:`FileStorage”实例

　　:类型字段_存储：文件存储

　　:param temporary:当文件实例被析构时是否删除文件

　　:型临时：型

　　返回一个缓冲的可写文件描述符

　　:rtype:缓冲文件存储

　　及格

　　NumPy

　　def func(path，field_storage，temporary):

　　的基本描述

　　扩展

　　因素

　　-

　　路径：字符串

　　要包装的文件的路径

　　field_storage :文件存储

　　要包装的“FileStorage”实例

　　临时：布尔

　　当文件实例被析构时是否删除文件

　　返回

　　-

　　缓冲文件存储

　　缓冲的可写文件描述符

　　及格

　　谷歌(官方推荐)

　　def func(path，field_storage，temporary):

　　的基本描述

　　扩展

　　Args:

　　要换行的文件的路径

　　field _ storage(file storage):要包装的：class:`FileStorage”实例

　　temporary (bool):当文件实例被析构时是否删除文件

　　返回：

　　一个缓冲的可写文件描述符

　　及格

　　Style适用于reStructuredText用冒号分隔PyCharm默认NumPy用下划线分隔垂直、长而深的文档Google用缩进分隔水平、短而简单的文档Sphinx对比NumPy和Google style，如果英文不好请参考中文版。

小技巧

　　Ctrl Q可以快速查看PyCharm中的评论

代码规范（含代码注释）

代码缩进和冒号

　　注意，条件语句必须严格控制缩进，以保证母句和分句的关系。

　　num=10

　　如果num5:

　　打印(“是”)

　　else:

　　打印(“否”)

空行分隔代码段

　　比如if语句判断，while循环，For循环，def函数，class类等。最好在代码段前后各留一行(手动分段落)。

　　# if语句

　　如果num5:

　　打印(“是”)

　　else:

　　打印(“否”)

　　# for循环

　　对于(1，2，4):中的I

　　打印(一)

　　# while循环

　　而i3:

　　打印(“是”)

　　i=1

　　else:

　　打印(“结束”)

　　#函数定义

　　定义显示():

　　打印(132)

　　#类别定义

　　类别人员：

　　定义显示(自身):

　　打印(123)

包、模块的命名规范

　　1.封装3354要求小写(相当于文件夹)

　　2.模块——要求小写(相当于文件夹中的文件)。

类和对象的命名规范

　　1.类别——严格的驼峰式写作

　　2.对象——要求小写。

函数的命名规范

　　驼峰写作例如：indexUserPerson(非强迫)

代码注释

　　1.单行注释3354 #

　　2.多行注释3354(快捷键是Ctrl/)

　　三对单引号，python多行注释

　　以上个人经验，希望给你一个参考，也希望你能支持盛行的IT软件开发工作室。

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。