随着学习的深入,用不了多久,你就可以写复杂的上千甚至上万行的代码啦,有些代码你花了很久写出来,过了些天再回去看,发现竟然看不懂了,哈哈,这太正常了。 另外,你以后在工作中会发现,一个项目多是由几个甚至几十个开发人员一起做,你要调用别人写的代码,别人也要用你的,如果代码不加注释,你自己都看不懂,更别说别人了,这样写会挨打的。所以为了避免这种尴尬的事情发生,一定要增加你代码的可读性。

代码注释分单行和多行注释, 单行注释用#,多行注释可以用三对双引号“”” “””

下面给大家看一段标准代码的注释,忽略代码意思

  1. def subclass_exception(name, parents, module, attached_to=None):
  2. """
  3. Create exception subclass. Used by ModelBase below.
  4. If 'attached_to' is supplied, the exception will be created in a way that
  5. allows it to be pickled, assuming the returned exception class will be added
  6. as an attribute to the 'attached_to' class.
  7. """
  8. class_dict = {'__module__': module}
  9. if attached_to is not None:
  10. def __reduce__(self):
  11. # Exceptions are special - they've got state that isn't
  12. # in self.__dict__. We assume it is all in self.args.
  13. return (unpickle_inner_exception, (attached_to, name), self.args)
  14. def __setstate__(self, args):
  15. self.args = args
  16. class_dict['__reduce__'] = __reduce__
  17. class_dict['__setstate__'] = __setstate__
  18. return type(name, parents, class_dict)

代码注释原则:

  1. 不用给全部代码加注释,只需要在自己觉得重要或不好理解的部分加注释即可
  1. 注释可以用中文或英文,但绝对不要拼音噢
  1. 注释不光要给自己看,还要给别人看,所以请认真写

转载于:https://www.cnblogs.com/lele234/p/11242324.html

小猿圈python学习-注释相关推荐

  1. 小猿圈python金角大王_小猿圈python学习-基本数据类型

    小猿圈python学习-基本数据类型 2019-04-24 11:16:14 1点赞 6收藏 0评论 什么是数据类型? 我们人类可以很容易的分清数字与字符的区别,但是计算机并不能呀,计算机虽然很强大, ...

  2. 小猿圈Python学习教程之后端接收前端回传的文件方法

    现在人工智能已经深入到千家万户,随之而来的就是python技术的火爆,今天小猿圈python讲师为你讲解一下后端接收前端回传的文件方法,希望对于刚刚自学python的你有一定的帮助. 如下所示: fi ...

  3. 小猿圈python学习-Selenium爬虫之使用代理ip的方法

    今天小猿圈给大家分享的是如何在爬取数据的时候防止IP被封,今天给大家分享两种方法,希望大家可以认真学习,再也不用 担心被封IP啦. 第一种: 降低访问速度,我们可以使用time模块中的sleep,使程 ...

  4. 小猿学python_小猿圈python学习之编程语言排名

    我们很多人在选择学一门编程语言的时候都会通过所学语言的人数排行来确定,因为用的人多意味着以后找工作的范围大一些,今天小猿圈就给大家分享目前各大编程语言的排名,以便于大家参考 排名前十的依旧是:Java ...

  5. 小猿圈 python学习-细讲数据类型-字典

    引子 我们学了列表 , 现在有个需求, 把你们公司每个员工的姓名.年龄.职务.工资存到列表里,你怎么存? staff_list = [ ["Alex",23,"CEO&q ...

  6. 银角大王 python_小猿圈python学习-细讲数据类型-列表

    第一章我们大概介绍了列表的基本用法,本节我们学习下 定义:[]内以逗号分隔,按照索引,存放各种数据类型,每个位置代表一个元素 再回顾下列表的特点: 1.可存放多个值 2.按照从左到右的顺序定义列表元素 ...

  7. android调用python模块 chaquo_小猿圈python学习-系统调用os模块

    os 模块提供了很多允许你的程序与操作系统直接交互的功能 得到当前工作目录,即当前Python脚本工作的目录路径: os.getcwd()返回指定目录下的所有文件和目录名:os.listdir()函数 ...

  8. 小猿圈python学习-面向对象语法

    面向过程 VS 面向对象 编程范式 编程是 程序 员 用特定的语法+数据结构+算法组成的代码来告诉计算机如何执行任务的过程 , 一个程序是程序员为了得到一个任务结果而编写的一组指令的集合,正所谓条条大 ...

  9. 小猿圈python学习-函数的递归

    求100不断除以2直到商为0为止,打印每次除的商 用循环实现 n = 100 while n > 0: n = int(n/2) print(n) 输出: 50 25 12 6 3 1 0 如果 ...

最新文章

  1. 《基于张量网络的学习入门》学习笔记3
  2. 天气预报c是什么意思_大雪节气将至,为什么老话说:寒风迎大雪,三九天气暖?...
  3. VC控件DateTimePicker使用方法及其相关
  4. scala集合常用方法:foldRight
  5. 为Visual studio 2008 添加汇编工程模板
  6. 华为鸿蒙系统不卡,华为鸿蒙系统,到底能不能取代安卓?网友:细节决定成败...
  7. 9.5 LSMW程序创建操作手册 第12 13 14步
  8. 外媒:苹果首款AR/VR设备需与iPhone绑定使用,最早明年发布
  9. 关于虚拟机virtualbox使用无线卡上网的设置
  10. AD教程系列 | 4 - 创建集成库文件
  11. 在Sbo Add-on插件中实现通用的模态数据选择
  12. cf1504E - Travelling Salesman Problem
  13. 优化无止境,爱奇艺中后台 Web 应用性能优化实践
  14. 华为RH2288 V3服务器新加硬盘不识别
  15. 谈软件系统的标准化和产品化
  16. abupy文件结构功能
  17. PHP框架中Symfony对数据库的操作
  18. pcf8563 C语言编程
  19. cygwin setup
  20. 数通运营商方向常见面试问题(第三部分)

热门文章

  1. Spring Boot微信点餐——实战开发DAO层
  2. RHCE 学习笔记(22) 网络用户
  3. 10分钟部署一个数据中心
  4. 【翻译】Ext JS 4.2介绍
  5. struts标签判断两个session中的字符串值是否相等
  6. 2.4 Add a dynamic map
  7. SQL 2005单用户启动实例
  8. linux杀java线程,如何在Linux下找出大量占用CPU的java线程
  9. 软件设计原则——合成复用原则
  10. java.lang.Thread 和 java.lang.Runnable的区别