4.python代码注释

2020 年 3 月 12 日
筆記

4.python代码注释

最后更新于：2019-10-05 14:25:41

在 python改变世界,从hello world开始中我们已经完成了第一个python程序，代码是有了，关键是好像好不知道写的啥玩意？

一.什么是代码注释

代码注释就是给一段代码加上说明，表明这段代码的作用或者实现的功能，方便别人阅读代码。打个形象的比喻：

问题来了，那个女孩是谁？张三？李四？王五？

加上注释再来一遍：放开小红。大家就都明白了，这个女孩叫小红。

二.为什么写代码要注释

IT圈有一个梗：当我写这段代码的时候,只有上帝和我知道,现在,只有上帝知道。上帝说：这个锅我不背！

IT圈有一句话：提交代码不写注释的人，小JJ就跟注释一样长。一个团队开发时候可能是多个人同时接管一个项目，注释都没有，谁知道你写的什么玩意？

三.python代码注释的几种方式

1.单行注释，使用英文符号 #

  # python注释代码 1  # python注释代码 2  # python注释代码 3  # python注释代码 4

2.多行注释

方法一：英文状态下使用单引号

  '''  python注释代码 1  python注释代码 2  python注释代码 3  python注释代码 4  '''

方法二：英文状态下使用双引号(和方法一有点类似)

    """  python注释代码 1  python注释代码 2  python注释代码 3  python注释代码 4  """

方法三：选中单行或者多行，使用快捷键 Ctrl+/

# python注释代码 1  # python注释代码 2  # python注释代码 3  # python注释代码 4

四.回到第一个python项目-helloworld

  # !usr/bin/env python  # -*- coding:utf-8 _*-  """  @Author:何以解忧  @Blog(个人博客地址): shuopython.com  @WeChat Official Account(微信公众号)：猿说python  @Github:www.github.com    @File:helloworld.py  @Time:2019/9/12 20:37    @Motto:不积跬步无以至千里，不积小流无以成江海，程序人生的精彩需要坚持不懈地积累！  """  print("hello word")

上面程序代码一共15行，其中前面的14行都是注释，值得注意的是：被注释的代码，程序在执行的时候会直跳过，也就是说程序重第15行开始执行。整个项目其实就一行代码，其余都是模板文件，如果你想设置一个属于你独有的模板头文件，请参考:pycharm设置文件模板

五.重点总结

总体说来python编程中的注释一共两个作用：

1.方便代码阅读

2.被注释的代码，程序不会执行

值得注意的是：如果程序的注释不是在代码的开始，那么该行代码一样会被执行，如下：

案例一：

print("helloworld") # python 编程创建的第一个项目

案例二:

# python 编程创建的第一个项目  print("helloworld")

两个案例效果一样，都会输出helloworld ,写法等效。