python注释

注释规范算是代码规范中的一个子集

注释分为多行注释和单行注释
多行注释我们可以使用三引号

"""
这是
多行
注释
"""
print('hello world')

单行注释我们用 #
在pycharm中我们可以使用ctrl+/来快速注释和反注释代码块
选中要注释的代码块ctrl+/
不选中只是注释光标所在行

# 这是单行注释
print('hello world')

注释通常来说是给人看的,帮助人理解代码是干什么的.
但是要知道只要是写在代码当中的东西,都是要经过机器的执行的
机器执行了之后
机器说这个注释不归我管
所以他没有执行结果而已

但是也有一类特殊注释,机器是要多管闲事的

特殊注释

• 
  
  • 关于#!/usr/bin/env python

必须是文件的第一行

必须以#!开头

• 关于#!/usr/bin/env python

告诉LINUX/UNIX去找到python的翻译器。

• 关于： # -- coding: utf-8 --

基本上在文件的第二行，在#!/usr/bin/env python的下一行

python interpret如何解释字符串的编码

当你的文件中出现中文的时候，你必须使用它

其他

TODO 和pass

TODO表示需要做而未做的一些待完成的事项，有助于事后的检索，以及对整体项目做进一步的修改迭代。

1# TODO([email protected]): Use a "*" here for string repetition.
2# TODO(lcqbug) Change this to use relations.

最好在注释中包含一个截止日期（“2009年11月解决”）或等待一个特定事件的发生（“等到所有的客户都可以处理XML请求就移除这些代码”）。
一些基本要求和规范：

• TODO注释应该在所有开头处包含”TODO”字符串,
• 紧跟着是用括号括起来的你的名字, email地址或其它标识符.
• 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么. 主要目的是为了有一个统一的TODO格式,
• 这样添加注释的人就可以搜索到(并可以按需提供更多细节).
  在 PyCharm 中，使用 Alt + 6 快捷键，可快速调出项目中的全部 TODO 注释；
  在标签栏这里我们可以看到所有的代办事项TODO
  

关于pass,
为了保证python语句语法的完整性而使用的,通常用在复杂业务逻辑中站位,可以配合TODO来使用

友情链接