python,代码注释,规范
后端开发-Python教程
经典bcb源码,vscode安装百度云,ubuntu唤醒屏幕,tomcat文件上传权限,香港爬虫入港,php 显示星期几,濮阳seo关键词优化方法,2016新年祝福网站源码lzw
A、代码注释介绍摄影源码,代码思路 vscode,ubuntu切换用户,zabbix监控tomcat,sqlite保存数据,深圳网页设计的公司有哪些,mysql数据库空间大小,耐思尼克免费服务器,微信贺卡插件,大数据前端框架,草爬虫,php文件路径,seo查询工具,springboot 切换日志,display标签 中文,家具营销型网站,创意响应式网页模版,dz网站模板 首页显示内容,magento登陆后台,html5页面全屏,网站后台管理系统php,飘叶电脑返修程序lzw
注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。云浏览器网站源码下载,ubuntu界面变成英文,风流老师 蚂蚁爬虫,php后端薪资,seo深圳培训lzw
在有处理逻辑的代码中，源程序有效注释量必须在20％以上。B、代码注释分类
行注释：在符号后那一行不会被编译（显示）
块注释：被块注释符号中间的部分不会被编译
C、python代码注释基础
Python中使用#表示单行注释。单行注释可以作为单独的一行放在被注释代码行之上，也可以放在语句或表达式之后。如下例子：
Python中使用三个单引号或三个双引号表示多行注释。用在注释多写不下的情况，如下例子：
D、DocStrings介绍与使用
4.1 DocStrings介绍
文档字符串
是一个重要工具，用于解释文档程序，帮助你的程序文档更加简单易懂
4.2 python中使用DocStrings
在函数体的第一行使用一对三个单引号 ”’ 或者一对三个双引号 “”” 来定义文档字符串。你可以使用 doc（注意双下划线）调用函数中的文档字符串属性。
编写示例如下：
def add(num1,num2): """ 完成传入的两个数之和 :param num1: 加数1 :param num2: 加数2 :return: 和 """ return num1 + num2print( add.__doc__ )
备注：DocStrings 文档字符串使用惯例：它的首行简述函数功能，第二行空行，第三行为函数的具体描述。
E、DocStrings常用编写风格
5.1 reST风格
这是现在流行的一种风格，reST风格，Sphinx的御用格式，比较紧凑。
"""This is a reST style.:param param1: this is a first param:param param2: this is a second param:returns: this is a description of what is returned:raises keyError: raises an exception"""
5.2 Google风格
"""This is a groups style docs.Parameters: param1 - this is the first param param2 - this is a second paramReturns: This is a description of what is returnedRaises: KeyError - raises an exception"""
5.3 Numpydoc (Numpy风格)
"""My numpydoc description of a kindof very exhautive numpydoc format docstring.Parameters----------first : array_like the 1st param name `first`second : the 2nd paramthird : {'value', 'other'}, optional the 3rd param, by default 'value'Returns-------string a value in a stringRaises------KeyError when a key errorOtherError when an other error"""F、一些注释经验
注释不是越多越好。对于一目了然的代码，不需要添加注释。对于复杂的操作，应该在操作开始前写上相应的注释。对于不是一目了然的代码，应该在代码之后添加注释。绝对不要描述代码。一般阅读代码的人都了解Python的语法，只是不知道代码要干什么