零、怎么编写注释

编写注释的方式有三种:
1.以 # 开头
2.以三个 开头和结尾
3.以三个 " 开头和结尾

# 定义一个字符串变量
name = '张三'# 定义一个函数
def GetName():return namedef SetName(n):''':param n: 姓名:return:'''name = ndef SetAge(age):""":param age: 年龄:return:"""return age

单引号和双引号注释中出现了**:para 参数名:return:**,param是对每个参数的描述,return是对返回值的描述

一、规则

注释具有两个功能:
1.对所编写的代码解释说明
2.表明编写代码的思路
结合以上两点,我们在编写代码的时候应遵循 简单明了 。所谓简单明了,就是指要用简练的语言清晰的描述出代码所要做的事情/编写代码的思路。还应注意的是,#注释一般用于函数/方法内的代码注释,单引号和双引号注释一般用于函数/类/方法本身的注释

二、 小结

本节主要讲解了注释的写法,请读者牢记注释的规则

觉得不错打赏一下吧,金额随意!

转载于:https://www.cnblogs.com/BMFramework/p/10017241.html

第二章--第二节:注释相关推荐

  1. 软件构造 第二章 第一节 软件生命周期和版本控制

    软件构造第二章 第一节 软件生命周期和版本控制 基本内容 Software Development Lifecycle (SDLC) Traditional software process mode ...

  2. 第二节认识计算机教案,第二章 第二节 局域网的构建 教学设计_博客

    <第二章 第二节 局域网的构建 教学设计_博客>由会员分享,可在线阅读,更多相关<第二章 第二节 局域网的构建 教学设计_博客(3页珍藏版)>请在装配图网上搜索. 1.第二章 ...

  3. 思维导图下载 注册安全_2019安全工程师《建筑实务》第二章第一节考点:物料提升机思维导图...

    2019安全工程师<安全生产专业实务-建筑施工安全>第二章第一节考点:物料提升机思维导图,本节的大部分知识点前两节塔式起重机和施工升降机相似,大家可以对比之前考点的思维导图来理解记忆,本知 ...

  4. 《啊哈!算法》第二章 - 第一节 - 解密QQ号(Java实现)

    <啊哈!算法>第二章 - 第一节- 解密QQ号(Java实现) 解密QQ号--队列 解密QQ号--队列 新学期开始了,小哈是小哼的新同桌(小哈是个小美女哦~),小哼向小哈询问 QQ号, 小 ...

  5. [读书笔记][20个月赚130亿]-第二章第二节-165号

    我读了20个月赚130亿的, 第二章第二节,165号. 大学路165号, 离斯坦福大学很近的一个地方,学生经常经过的一个地方,那是一个幸运的地方,有个很多成功的公司在那里,谷歌,paypal, 罗技. ...

  6. 根据黑马pink老师讲的bootstrap而做的笔记(不过多赘述,简洁高效)第二章 第二节 bootstrap前端开发框架以按钮为例(引用网站上已经设置的布局和样式)

    咱们大部分围绕着两个问题来叙述 是什么? 怎么做? 一.目录(总体,这门课要学的目录)(现在是第二章,bootstrap前端开发框架) 1.响应式开发 2.bootstrap前端开发框架 3.boot ...

  7. linux 下  qserialport waitforreadyread_北师大版初中数学八年级(下)第二章第一节不等关系(精品)...

    第二章 一元一次不等式与 一元一次不等式组 2.1不等关系 一.知识点梳理 不等式:一般地,用"<"(或"≤"),">"(或&q ...

  8. 第二章第一节 能把梳子卖给和尚吗

    第二章 能把梳子卖给和尚吗 1.求职遭遇奇妙陷阱 话说刘备大四毕业那年春天,卢植因为得罪了校办公室主任左丰,被指控犯罪批捕入狱,案由涉及男女情色和贪污受贿.直到刘备毕业离校,才因为查无实据而无罪获释. ...

  9. 带你玩转区块链--以太坊基础、发币、基于智能合约实现彩票项目-第二章-第一节【以太坊篇】

    意义: 在上一节知识学习中,我们已经了解如何实现一个基础区块链,并重构了BTC关键代码.对比传统的中心化项目,区块链项目拥有很多优势,如:追溯性.不可传篡改性.在中心化项目中的网络协议是:[数据层-- ...

  10. 第二章 第二节 安装Eclipse

    第二节  安装Eclipse 返回目录 Eclipse.org站点提供整个Eclipse系统的下载,包括SWT和JFace.下载主站是http://www.eclipse.org/downloads. ...

最新文章

  1. 推荐一个关于.NET平台数据结构和算法的好项目
  2. threshold 二值化的实现
  3. python解释器pypy
  4. 实现双击IE9的Tab键关闭当前页面的功能
  5. C/C++:程序的内存分配方式
  6. Django的电子商务网站的调研
  7. 计算机组成原理袁春风百度云,计算机组成原理 袁春风chap3homework.pdf
  8. php代码提示助手,laravel自动补全助手ide-helper安置及配置
  9. hnu 暑期实训之7还是7 to_string的实现方法
  10. java录音程序_record类完成语音信号采集的任务_Android实现语音数据实时采集、播放...
  11. 一篇文章告诉你[C++]数组初始化
  12. Redis结合Lua脚本实现高并发原子性操作
  13. Linux目录结构、bash的基础命令学习
  14. echarts 自定义鼠标悬停展示
  15. 使用开源项目DCRM搭建Cydia源服务器
  16. cdma特有效应_cdma系统中的远近效应
  17. R语言绘制Cleverland点图
  18. java什么是布尔型_Java新职篇:是什么是布尔型?
  19. [异常退出,错误代码0xC0000005]:解决Windows应用程序崩溃的问题
  20. phpmailer的使用方法

热门文章

  1. day42.自动关机小程序
  2. 《唯有时间能证明伟大:极客之王特斯拉传》读后感
  3. python,matlab 读取NIFTI(.nii)格式图像、FSL安装
  4. Oracle (01)Oracle数据库的安装步骤.搭建上课所用的数据库环境.table (二维表).查看表结构.数据库中常用的数据类型
  5. CST仿真指导 | 利用软件自带的示例与教程快速建模仿真
  6. 如何在线将flac格式转换成mp3音频
  7. c# 定义四边形_C# 绘制多边形
  8. Java个人职业发展方向
  9. 从TiDB上线阿里云的背后,如何看待云数据库的变革趋势
  10. TeamViewer 可信设备的信任管理