本文内容主要介绍了Python代码注释规范代码实例解析,通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下!!!

一、代码注释介绍

注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。

注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。

在有处理逻辑的代码中,源程序有效注释量必须在20%以上。

二、代码注释分类

行注释:在符号后那一行不会被编译(显示)

块注释:被块注释符号中间的部分不会被编译

三、python代码注释基础

Python中使用#表示单行注释。单行注释可以作为单独的一行放在被注释代码行之上,也可以放在语句或表达式之后。如下例子:

name = 'xiaohong' # 单行注释

# 单行注释name = 'xiaohong'

Python中使用三个单引号或三个双引号表示多行注释。用在注释多写不下的情况,如下例子:

'''这是使用三个单引号的多行注释'''

"""这是使用三个双引号的多行注释"""

四、DocStrings介绍与使用

4.1 DocStrings介绍

文档字符串

是一个重要工具,用于解释文档程序,帮助你的程序文档更加简单易懂

4.2 python中使用DocStrings

在函数体的第一行使用一对三个单引号 ''' 或者一对三个双引号 """ 来定义文档字符串。你可以使用 doc(注意双下划线)调用函数中的文档字符串属性。

编写示例如下:

5.2 Google风格

5.3 Numpydoc (Numpy风格)

六、一些注释经验

注释不是越多越好。对于一目了然的代码,不需要添加注释。

对于复杂的操作,应该在操作开始前写上相应的注释。

对于不是一目了然的代码,应该在代码之后添加注释。

绝对不要描述代码。一般阅读代码的人都了解Python的语法,只是不知道代码要干什么

python代码大全中文注释_零基础小白必看篇:Python代码注释规范代码实例解析操作(收藏)...相关推荐

  1. python代码_零基础小白必看篇:Python代码注释规范代码实例解析操作(收藏)

    本文内容主要介绍了Python代码注释规范代码实例解析,通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下!!! 一.代码注释介绍 注释就是对代码的解释和说明 ...

  2. python删除文件夹无法访问_零基础小白必看:python基本操作-文件、目录及路径

    使用python的os模块,简单方便完成对文件夹.文件及路径的管理与访问操作. 1 前言 在最近开发中,经常需要对文件进行读取.遍历.修改等操作,想要快速.简单的完成这些操作,我选择用 python ...

  3. python目录及文件_零基础小白必看:python基本操作-文件、目录及路径

    1 前言 在最近开发中,经常需要对文件进行读取.遍历.修改等操作,想要快速.简单的完成这些操作,我选择用 python .通过 python 的标准内置 os 模块,只需要几行代码,即可完成想要的操作 ...

  4. 怎么安装python_零基础入门必看篇:浅析python,PyCharm,Anaconda三者之间关系

    今天为大家带来的内容是:零基础入门必看篇:浅析python ,PyCharm,Anaconda三者之间关系 众所周知,Python是一种跨平台的计算机程序设计语言,简单来说,python就是类似于C, ...

  5. 零基础学员必看的python课程大纲

    零基础学员必看的python课程大纲,Python是一种面向对象的解释型计算机程序设计语言,纯粹的自由软件,适合没有编程基础的学员,其常被昵称为胶水语言,能够把用其他语言制作的各种模块(尤其是C/C+ ...

  6. 小白到学会python要多久_零基础小白多久能学会python

    学习任何一门编程语言,都是为了去实现一个个项目,来解决实际的问题.无论项目是大还是小,都关联着许多知识与技能. 例如要写一个「文件资源管理器」的应用,就需要MVC设计模式.组件化构建.对象集合及操作. ...

  7. 类似零基础学python的小说_零基础小白十分钟用Python搭建小说网站!Python真的强!...

    零基础小白十分钟用Python搭建小说网站!Python真的强!-1.jpg (128.29 KB, 下载次数: 0) 2018-10-8 18:51 上传 Python 和放大镜的二进制代码 人生苦 ...

  8. python学多久可以接单-零基础小白多久能学会python

    学习任何一门编程语言,都是为了去实现一个个项目,来解决实际的问题.无论项目是大还是小,都关联着许多知识与技能. 例如要写一个「文件资源管理器」的应用,就需要MVC设计模式.组件化构建.对象集合及操作. ...

  9. 初学python有几个阶段_零基础如何系统的学习Python 从7个阶段入手

    目前信息化产业发展势头很好,互联网就成为了很多普通人想要涉及的行业,因为相比于传统行业,互联网行业涨薪幅度大,机会也多,所以就会大批的人想要转行来学习Python开发. Python语言的应用 Pyt ...

最新文章

  1. 有关项目实施【老男孩】的经验分享
  2. 易宝支付碰到 交易签名无效问题
  3. Nginx 502报错(django+nginx,而非php-fmp)
  4. js迭代器实现斐波那契数列
  5. python描述符魔术方法_Python类型转换的魔术方法详解
  6. PLC程序的组成结构
  7. 方舟生存进化掉落物代码
  8. Multisim10.0.1汉化时没有stringfiles问题
  9. 深度学习deep learning
  10. 计算机三级网络技术知识点大全(九)
  11. 硕士毕业论文奇偶页眉页脚的设置
  12. 百度 html 3d,百度地图实现3D棱柱
  13. Spark 的情感分析
  14. Dim Temp%的意思
  15. 爬虫登陆实战 --- QQ音乐扫码登陆
  16. 【简单详细】为Unity游戏制作开场动画video,新手必看
  17. 将爬取的实习僧网站数据传入HDFS
  18. linux中磁盘清理方法(简单好用)
  19. 根据当前日期获取一年前的日期
  20. 【OpenGL】绘制一个点

热门文章

  1. python如何读取csv文件某几行某几列_关于python:读取.csv文件时,我似乎无法指定列dtypes...
  2. Linux命令 umask,chmod使用
  3. C和C++结构体区别
  4. 连接真机开发安卓(Android)移动app MUI框架 反馈意见、忘记密码、登录、底部选项卡、联系我们、导航等页面代码可拿——混合式开发(六)
  5. python 全栈开发,Day36(作业讲解(大文件下载以及进度条展示),socket的更多方法介绍,验证客户端链接的合法性hmac,socketserver)...
  6. jvm 加载class文件过程
  7. [codevs1262] 不要把球传我 数论+组合数学
  8. C#调用mciSendString播放音频文件
  9. 选择日期保存后日期变成前一天(avue date)
  10. java使用itext将图片放到pdf模板的指定位置