相传民间有一种“神奇”的代码,它们已经存在了十几年甚至数十年,被成为“祖传代码”。接手这样一份已经流传了很多年的代码,对于任何一个程序员来讲,通常都不会是一种愉快的体验,因为这些代码一般都比较乱并且缺少清晰的注释。如果要修复这种代码中的bug,怎一个痛不欲生了得。
写代码的过程中,对于晦涩难懂的部分,给出清晰简洁的注释,是一个编码的好习惯。那么Python代码中如何写注释呢?
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# A comment, this is so you can read your program later.
# Anything after the # is ignore by python
print("I could have code like this") # and the comment after is ignored
# you can also use a comment to "disable" or comment out a piece of code:
# print "This won't run."
print("This is run.")
运行上面这段代码
仔细观察,不难发现,#
后的内容都没有输出。没错!#
就是Python语言中的注释符号,用它表示一行注释的开始,它可以出现在Python的任意一行,也可以出现在一条Python语句的后面。注释不会被Python解释器解释。
小结
-
#
是Python语言中的注释符号。 - 编写清晰简洁的注释是一个良好的编程习惯。