Python 注释:解释和优化代码可读性

小万哥
• 阅读 372

注释可以用来解释Python代码。注释可以用来使代码更易读。注释可以用来在测试代码时防止执行。

创建注释

注释以#开始,Python会忽略它们:

示例:获取您自己的Python注释

# 这是一个注释
print("Hello, World!")

注释可以放在一行的末尾,Python会忽略行的其余部分:

示例

print("Hello, World!") # 这是一个注释

注释不一定是解释代码的文本,还可以用来防止Python执行代码:

示例

# print("Hello, World!")
print("Cheers, Mate!")

多行注释

Python实际上没有多行注释的语法。

要添加多行注释,您可以为每一行插入一个#:

示例

# 这是一个注释
# 写在
# 不止一行的地方
print("Hello, World!")

或者,尽管不是原意,您可以使用多行字符串。

由于Python会忽略未分配给变量的字符串文字,您可以在代码中添加一个多行字符串(三重引号),然后将注释放在其中:

示例

"""
这是一个注释
写在
不止一行的地方
"""
print("Hello, World!")

最后

为了方便其他设备和平台的小伙伴观看往期文章,链接奉上:

公众号搜索Let us Coding知乎开源中国CSDN思否掘金InfoQ简书博客园慕课51CTOhelloworld腾讯开发者社区阿里开发者社区

看完如果觉得有帮助,欢迎点赞、收藏关注

点赞
收藏
评论区
推荐文章
焦飞 焦飞
3年前
Pytorch使用CNN实现手写数字识别(详细注释)
环境:python3、torch1.2.0(torch1.5.0也可以)、torchvision0.4.0代码:(注:DOWNLOADMNISTFalse第一次应该设为True,原因在代码注释里)pythonimporttorchfromtorch.autogradimportVariableimporttorch.utils.dataa
Wesley13 Wesley13
3年前
java基础之 java注释
JAVA里有2中注释风格。一种以“/\”开始以“\/”结尾,另一种是以“//”起头的。被注释的内容不会被java虚拟机编译,所以这就是为什么用反编译编译源代码没有注释的原因。举个栗子packagetest;publicclassJavaDoc{/这是单行注释/
lucien-ma lucien-ma
3年前
python文件的第一行 #!/usr/bin/python3 是什么意思?
python文件的第一行代码通常在脚本语言的第一行会看到:!/usr/bin/envpython或!/usr/bin/python首先要确定的一点是它不是注释。这两句话的目的都是指出你的python文件用什么可执行程序去运行它。1.!/usr/bin/python是告诉操作系统执行这个脚本的时候,调用/usr/bin下的python解释
Wesley13 Wesley13
3年前
java编程中使用二进制进行权限或状态控制
直接看代码以及注释吧。@Testpublicvoidmain(){//PCWEB端intpc1<<0;//...00011//Android端intandroid1<<
Bill78 Bill78
3年前
python基础知识总结
一、Python的优缺点优点:1.简单,易学,免费,开源2.高级语言,解释型语言3.可移植性,可拓展性,可读性4.面向对象,丰富的库缺点:1.执行效率慢2.GIL锁限制并发3.源代码加密困难二、Python的注释
Stella981 Stella981
3年前
IDE netbeans 任务 任务列表 TODO
在代码中写入注释//TODO这里是注释netbeans中的任务列表就会显示这个注释这是Thinkphp中用到的代码版本 |版本信息:ThinkPHP3.0Release2012/3/5 类        abstractclassAction 方法    ajaxReturn行数  329   
Wesley13 Wesley13
3年前
C++ 注释
C注释程序的注释是解释性语句,您可以在C代码中包含注释,这将提高源代码的可读性。所有的编程语言都允许某种形式的注释。C支持单行注释和多行注释。注释中的所有字符会被C编译器忽略。1include<iostream23/runthisprogramusingthe
小万哥 小万哥
1年前
C 语言注释和变量详解
C语言中的注释C语言中可以使用注释来解释代码并使其更具可读性。它还可以在测试替代代码时防止执行。单行注释单行注释以两个斜杠(//)开头。//和行末之间的任何文本都会被编译器忽略(不会被执行)。此示例在代码行之前使用单行注释:c//这是一个注释printf(
融云IM即时通讯 融云IM即时通讯
11个月前
如何自定义选图功能?
1,你可以更改功能板上的各个图标按钮和响应,你可以参考RCDChatViewController文件中的注释。2,根据1提到的注释,加上如下代码(void)pluginBoardView:(RCPluginBoardView)pluginBoardView
敏捷开发 敏捷开发
4个月前
写不好代码注释?这份注释指南一定要收好!
之前有读者问,自己一直不明白如何写出合理的代码注释。这也是不少程序员一直头疼的问题,比如接手新代码时,没有注释,完全搞不清逻辑;自己写的注释,跟不上代码修改,成了误导;复杂逻辑不知道咋注释,别人也看不懂。(听君一席话,听了一席话)网上也有很多关于代码注释的