python中怎么注释

Go 语言是可能是最近几年里你经常听人说起的编程语言。尽管它在 2009 年已经发布了，但它最近才开始流行起来。

根据 Google 趋势，Go 语言非常流行。

这篇文章不会讨论一些你经常看到的 Go 语言的主要特性。

相反，我想向您介绍一些相当小众但仍然很重要的功能。只有在您决定尝试 Go 语言后，您才会知道这些功能。

这些都是表面上没有体现出来的惊人特性，但它们可以为您节省数周或数月的工作量。而且这些特性还可以使软件开发更加愉快。

阅读本文不需要任何语言经验，所以不必担心你还不了解 Go 语言。如果你想了解更多，可以看看我在底部列出的一些额外的链接。

我们将讨论以下主题：

GoDoc静态代码分析内置的测试和分析框架竞争条件检测学习曲线反射Opinionatedness文化

请注意，这个列表不遵循任何特定顺序来讨论。

GoDoc

Go 语言非常重视代码中的文档，所以也很简洁。

GoDoc 是一个静态代码分析工具，可以直接从代码中创建漂亮的文档页面。GoDoc 的一个显著特点是它不使用任何其他的语言，如 JavaDoc、PHPDoc 或 JSDoc 来注释代码中的结构，只需要用英语。

它使用从代码中获取的尽可能多的信息来概述、构造和格式化文档。它有多而全的功能，比如：交叉引用、代码示例，并直接链接到你的版本控制系统仓库。

而你需要做的只有添加一些像 // MyFunc transforms Foo into Bar 这样子的老牌注释，而这些注释也会反映在的文档中。你甚至可以添加一些通过网络界面或者在本地可以实际运行的 代码示例 。

GoDoc 是 Go 的唯一文档引擎，整个社区都在使用。这意味着用 Go 编写的每个库或应用程序都具有相同的文档格式。从长远来看，它可以帮你在浏览这些文档时节省大量时间。

例如，这是我最近一个小项目的 GoDoc 页面： pullkee—GoDoc 。

静态代码分析

Go 严重依赖于静态代码分析。例如用于文档的 godoc ，用于代码格式化的 gofmt ，用于代码风格的 golint ，等等。

它们是如此之多，甚至有一个总揽了它们的项目 gometalinter ，将它们组合成了单一的实用程序。

这些工具通常作为独立的命令行应用程序实现，并可轻松与任何编码环境集成。

静态代码分析实际上并不是现代编程的新概念，但是 Go 将其带入了绝对的范畴。我无法估量它为我节省了多少时间。此外，它给你一种安全感，就像有人在你背后支持你一样。

创建自己的分析器非常简单，因为 Go 有专门的内置包来解析和加工 Go 源码。

你可以从这个链接中了解到更多相关内容: GothamGo Kickoff Meetup: Alan Donovan 的 Go 静态分析工具 。

内置的测试和分析框架

您是否曾尝试为一个从头开始的 JavaScript 项目选择测试框架？如果是这样，你或许会理解经历这种 过度分析(analysis paralysis)的痛苦。您可能也意识到您没有使用其中 80％ 的框架。

一旦您需要进行一些可靠的分析，问题就会重复出现。

Go 附带内置测试工具，旨在简化和提高效率。它为您提供了最简单的 API，并做出最小的假设。您可以将它用于不同类型的测试、分析，甚至可以提供可执行代码示例。

它可以开箱即用地生成便于持续集成的输出，而且它的用法很简单，只需运行 go test。当然，它还支持高级功能，如并行运行测试，跳过标记代码，以及其他更多功能。

竞争条件检测

您可能已经听说了 Goroutine，它们在 Go 中用于实现并发代码执行。如果你未曾了解过， 这里 有一个非常简短的解释。

无论具体技术如何，复杂应用中的并发编程都不容易，部分原因在于竞争条件的可能性。

简单地说，当几个并发操作以不可预测的顺序完成时，竞争条件就会发生。它可能会导致大量的错误，特别难以追查。如果你曾经花了一天时间调试集成测试，该测试仅在大约 80％ 的执行中起作用？这可能是竞争条件引起的。

总而言之，在 Go 中非常重视并发编程，幸运的是，我们有一个强大的工具来捕捉这些竞争条件。它完全集成到 Go 的工具链中。

您可以在这里阅读更多相关信息并了解如何使用它： 介绍 Go 中的竞争条件检测 - Go Blog 。

学习曲线

您可以在一个晚上学习所有的 Go 语言功能。我是认真的。当然，还有标准库，以及不同的，更具体领域的最佳实践。但是两个小时就足以让你自信地编写一个简单的 HTTP 服务器或命令行应用程序。

Go 语言拥有 出色的文档 ，大部分高级主题已经在他们的博客上进行了介绍： Go 编程语言博客 。

比起 Java（以及 Java 家族的语言）、Javascript、Ruby、Python 甚至 PHP，你可以更轻松地把 Go 语言带到你的团队中。由于环境易于设置，您的团队在完成第一个生产代码之前需要进行的投资要小得多。

反射

代码反射本质上是一种隐藏在编译器下并访问有关语言结构的各种元信息的能力，例如变量或函数。

鉴于 Go 是一种静态类型语言，当涉及更松散类型的抽象编程时，它会受到许多各种限制。特别是与 Javascript 或 Python 等语言相比。

此外，Go 没有实现一个名为泛型的概念 ，这使得以抽象方式处理多种类型更具挑战性。然而，由于泛型带来的复杂程度，许多人认为不实现泛型对语言实际上是有益的。我完全同意。

根据 Go 的理念（这是一个单独的主题），您应该努力不要过度设计您的解决方案。这也适用于动态类型编程。尽可能坚持使用静态类型，并在确切知道要处理的类型时使用 接口(interface)。接口在 Go 中非常强大且无处不在。

但是，仍然存在一些情况，你无法知道你处理的数据类型。一个很好的例子是 JSON。您可以在应用程序中来回转换所有类型的数据。字符串、缓冲区、各种数字、嵌套结构等。

为了解决这个问题，您需要一个工具来检查运行时的数据并根据其类型和结构采取不同行为。 反射(Reflect)可以帮到你。Go 拥有一流的反射包，使您的代码能够像 Javascript 这样的语言一样动态。

一个重要的警告是知道你使用它所带来的代价 —— 并且只有知道在没有更简单的方法时才使用它。

你可以在这里阅读更多相关信息: 反射的法则—Go 博客 .

您还可以在此处阅读 JSON 包源码中的一些实际代码: src/encoding/json/encode.go—Source Code

Opinionatedness（专制独裁的 Go）

顺便问一下，有这样一个单词吗？

来自 Javascript 世界，我面临的最艰巨的困难之一是决定我需要使用哪些约定和工具。我应该如何设计代码？我应该使用什么测试库？我该怎么设计结构？我应该依赖哪些编程范例和方法？

这有时候基本上让我卡住了。我需要花时间思考这些事情而不是编写代码并满足用户。

首先，我应该注意到我完全知道这些惯例的来源，它总是来源于你或者你的团队。无论如何，即使是一群经验丰富的 Javascript 开发人员也很容易发现他们在实现相同的结果时，而大部分的经验却是在完全不同的工具和范例上。

这导致整个团队中出现过度分析，并且使得个体之间更难以相互协作。

嗯，Go 是不同的。即使您对如何构建和维护代码有很多强烈的意见，例如：如何命名，要遵循哪些结构模式，如何更好地实现并发。但你只有一个每个人都遵循的风格指南。你只有一个内置在基本工具链中的测试框架。

虽然这似乎过于严格，但它为您和您的团队节省了大量时间。当你写代码时，受一点限制实际上是一件好事。在构建新代码时，它为您提供了一种更直接的方法，并且可以更容易地调试现有代码。

因此，大多数 Go 项目在代码方面看起来非常相似。

文化

人们说，每当你学习一门新的口语时，你也会沉浸在说这种语言的人的某些文化中。因此，您学习的语言越多，您可能会有更多的变化。

编程语言也是如此。无论您将来如何应用新的编程语言，它总能给你带来新的编程视角或某些特别的技术。

无论是函数式编程， 模式匹配(pattern matching)还是 原型继承(prototypal inheritance)。一旦你学会了它们，你就可以随身携带这些编程思想，这扩展了你作为软件开发人员所拥有的问题解决工具集。它们也改变了你阅读高质量代码的方式。

而 Go 在这方面有一项了不起的财富。Go 文化的主要支柱是保持简单，脚踏实地的代码，而不会产生许多冗余的抽象概念，并将可维护性放在首位。大部分时间花费在代码的编写工作上，而不是在修补工具和环境或者选择不同的实现方式上，这也是 Go 文化的一部分。

作为一名程序员，写代码要养成写注释的好习惯是非常重要的，这样不但有利于自己维护代码，也有助于其他人读自己的代码，同时也有利于工作的交接安排等，总之，写注释是百利而无一害的事情，即使这么的好，也有部分比较懒得的程序员也是不愿意去做。

另外要说的是，关于注释怎么写的问题，好像没人怎么要求过，对于大公司可能有一些具体的要求，写的注释有问题代码也是不能发布上线的，而对于小公司可能就完全不管了，因为注释你怎么写丝毫也不影响到代码的运行结果，所以在一些小公司，就出现了各种各样的代码注释，有的时候在代码的注释中就可以看到一些故事，比如是新老员工们在代码中展开的一些历史对话，看着蛮有意思，近期一名员工晒了一段代码，其中一行雷人的注释是别具一番风味，接下来让我们一起欣赏一下吧。其中注释是这么写的：“项目经理要求这儿运行缓慢，好让客户优化给钱，得到明显的提升”，针对这样的情况这名网友是这么说的：“这样的程序员也是够了，就不能隐晦点吗？换你的话会怎么写这备注？”，我想网友们肯定是有话要说吧，接下来我们看看他们都是怎么说的吧。

网友一：写的隐晦，到时候说不清楚，就得开发背锅了！

上世是朵花：的确是有一定的道理，不过我很想知道项目经理看到这段注释后的感受，或者说客户看到这段注释后的感受，也许他们很有可能看不到吧。

网友二：这个是java端吗

上世是朵花：看样子应该是java后端代码。

网友三：好多年以前的老梗了

上世是朵花：这样的梗之前也的确听说过，楼主说是别人发他的，难道这是真事？

网友四：方法命名不应该首字母小写嘛？

上世是朵花：没错，方法命名首字母应该小写，他这种写法不规范，不过注释都这么随意了，你还跟他要求啥命名规范呀。

网友五：Java括号换行会被打死，没看新闻吗

上世是朵花：是么？有这样的新闻？原谅我没听说过。

网友六：正直

上世是朵花：嗯，有这么一点意思，也算是一个耿直boy了。

网友七：明显是c#

上世是朵花：从哪里看出像c#了？

网友八：给钱光速

上世是朵花：光速是什么一个概念？想象不到。

这名网友分享的情况，以前在网上也曾有见过，看起来更像是一个老耿，不过也不可排除现实中的确有这样的事情，那么问题来了，如果是项目经理要求写一些不够厚道的代码，你会去写么？如果你写了，以后查出来可能就有背锅的风险，针对这样的情况你会怎么做呢？你会像文中这么去写注释来保护自己的权益么？或者说你有什么更好的做法来保护自己呢？欢迎在下方评论区写出你的做法或者观点。

以上所有图片均来之互联网 大家好，我是“上世是朵花”。如果你有什么好的看法或者观点可以在评论区展现你的才华，互动交流，如果想进一步了解我，那就关注我吧！

写在前面：

参考网络上代码编辑而成，无技术含量，可自行定制：

目前亲测有效，若有待完善之处，还望指出！

强调：将此统计py脚本放置项目的根目录下执行即可。

1、遍历文件，递归遍历文件夹中的所有

2、指定文件类型：项目的代码行数，故只考虑.py文件，当然也可在指定的文件类型列表whitelist中添加其他类型

3、过滤空行和注释，注意采用的读取文件模式为‘rb’

完整源码：

测试对象样本，test.py：

结果为：2

python中有两种注释：

看以下程序示例（未使用注释）：

看以下程序示例（使用注释）：

一、注释的作用：

增加程序的可读性，让开发者或后续接手程序进行维护修改的程序员提供可读性。

好的程序代码通常有50%是注释！

只要是被注释的代码都不会被执行！

二、注释的分类：

2.1 单行注释：

以井号“#”符号开头，其右边的都是注释，#字符开头的都是单行注释，内容不能换行，如果注释内容换行了，那么要在新的一行的，行首加一个#

如：

#以下代码用来打打印一个信息

print("hello world")

#这里是单行注释

#这是另一单行注释

2.2 多行注释：

三个单引号或三个双引号之间的

'''

print("hello world")

print("hello world")

print("hello world")

print("hello world")

'''

"""

三个双引号之间的内容都是注释

print("hello world")

print("hello world")

print("hello world")

"""

三、相关错误提示

代码：

#coding=utf-8

#这是一行注释

print("hello world")

'''

三个单引号之间的内容都是注释

print("hello world")

print("hello world")

print("hello world")

'''

"""

三个双引号之间的内容都是注释

print("hello world")

print("hello world")

print("hello world")

"""

执行以上代码，会提示如下错误：

SyntaxError: (unicode error) 'utf-8' codec can't decode

这是因为文件存储的格式是ANSI，只需用notepad++打开代码文件，以UTF-8格式编码保存即可。

菜鸟学Python之二：关于注释的那些事

大家好，我是@爱玩电脑，今天跟大家一起零基础入门学习Python的第二个知识点，关于注释的那些事，纯粹零基础入门，高手绕行。

镇楼图

普遍认为，在程序代码中写注释是很重要的。注释的作用我了解的大概有二个：一是对你写的代码进行说明，免得自己过一段时间后忘记写代码时候的思路了，或者别人接手你的代码，完全搞不清楚你写的什么玩意儿；二是临时把代码禁用掉，方便调试程序。当然，也有高手声称好的代码就是注释，坏的注释反而影响代码美观，反正是见仁见智，我们且不去争辩，先来看看Python中添加注释的方法吧。

一、单行注释

单行注释的符号是"#"，在程序段中输入井号后，整行的句子都变成注释语句了。

我们在IDLE中输入如下代码试试：

图一 单行注释

按F5，程序运行结果是这样的：

图二 运行结果

如果我们在第二个print语句前加上井号，

图三 把语句给注释掉

可以看到第二句print语句全部变成红色了。具体效果你可以自己试试。

二、多行注释

"#"在Python中只能用于注释一行语句，如果要注释一大段语句，用"#"来一句句的注释就显得太麻烦了，在Python中可以使用三个引号来进行多行注释的操作，如下图：

图四 多行注释

英文输入法下面的三个双引号效果也是一样的。

好吧，《菜鸟学Python之 二：关于注释的那些事》就讲到这里。文章由@爱玩电脑原创，转载请注明出处。

如果要在python2的py文件里面写中文，则必须要添加一行声明文件编码的注释，否则python2会默认使用ASCII编码。

[python] view plain copy

# -*- coding:utf-8 -*-

问题就来了，为什么要如此声明？

首先请参考python的PEP http://python.org/dev/peps/pep-0263/

概要如下

1.必须将编码注释放在第一行或者第二行

2.可选格式有

[python] view plain copy

# coding=

[python] view plain copy

#!/usr/bin/python # -*- coding: -*-

[python] view plain copy

#!/usr/bin/python # vim: set fileencoding=:

但是再往下看，发现其实只要注释里面有coding 和对应的编码就可以了，例如

[python] view plain copy

#!/usr/bin/python # vim: set fileencoding=:

所以搞了半天对最标准的做法也有点糊涂了。

后来想了想，看了下VIM中对python的语法高亮文件，里面把如下的正则表达式确定为编码声明

[plain] view plain copy

\%^.*\?#.*coding[:=]\s*[0-9A-Za-z-_.]\+.*$

对于这个正则有些有点看不懂，但是大致如下必须有coding:[编码]或者coding=[编码]才行，这个应该可以视作为标准的声明方式吧。

但是为什么通常这种方式呢？

[python] view plain copy

# -*- coding:utf-8 -*-

答案在PEP-0263里面有所提及，那就是Emacs等编辑器使用这种方式进行编码声明。

话说PEP里面很多东西都是很值得参考的毕竟可以知道为什么程序这样设计。

坚持每天更新，帮助入门python

小伙伴们，夜深了，给大家讲一讲python注释的吧。大家如果学习过c语言，就会知道程序的注释有什么用。这里多提一句吧，C语言的注释分两种，单行注释和多行注释。C语言的单行注释是最常用的是//，多行注释最常用的是

好了，言归正传我们继续来学习python吧，python常用单行注释是#，常用多行注释是三对单引号''' '''

全理论太抽象，我们一起来看一看例子吧~~~

一、单行注释

单行注释

第一个print

print 'woaipython','hello,world'

打印出来

woaipython hello,world

我们加上注释符#后，

print 'woaipython'#,'hello,world'

打印出来

woaipython

我们可以发现，注释符#后的代码是不会执行的。

二、多行注释

首先，我们来写一个有多行的小程序。

rint 'woaipython'print 'ilovepython'print 'hello'print 'world'print 'python'

我们运行一下这个小程序

我么可以看见打印出了许多数据，接下来我们给第2~4行加上多行注释

print 'woaipython'''' print 'ilovepython'print 'hello'print 'world' '''print 'python'

运行一下

我们可以看见只有第一行和第五行显示了。我们注释掉的2~4行没运行。

总结一下，注释符除了望文生义作注释用、解释程序意思的作用外，还可以把你不想运行也不想删除的程序段给屏蔽起来。

注：刚刚使用的编辑器是gnome桌面自带的gedit编辑器，需要先建一个拓展名为.py文件（命令：touch python.py）。编写完后保存，再使用命令python python.py就可以打印结果了。

每天学一点，积少成多。

后期会循序渐进、由浅入深的讲解python知识，如果想学习python入门，欢迎订阅。

如果还有不明白的小伙伴，欢迎留言评论或私信告诉我。

注释是对一段代码的解释和说明，可提高程序代码的可读性，让人们能够更加轻松地了解代码，尤其在大型项目开发和团队项目中，注释是必不可少的！

任何编程语言都少不了注释，Python也不例外，以下是Python注释的具体用法：

1. 单行注释

Python编程语言的单行注释常以#开头，单行注释可以作为单独的一行放在被注释代码行之上，也可以放在语句或者表达式之后。

实例：

# -*- coding: UTF-8 -*-

print ("hello world!"); #您好，世界

2. 多行注释

Python中多行注释使用三个单引号（’’’）或者三个双引号（”””）来标记，而实际上这是多行字符串的书写方式，并不是Python本身提倡的多行注释方法。

实例：

'''

这是多行注释，使用单引号。

这是多行注释，使用单引号。

'''

"""

这是多行注释，使用双引号。

这是多行注释，使用双引号。

"""

3. 编码注释

在进行Python开发时，需进行编码声明，如采用UTF-8编码，需在源码上方进行 # -*- coding: UTF-8 -*- 声明，从Python3开始，Python默认使用UTF-8编码，所以Python3.x的源文件不需要特殊声明UTF-8编码。

4. 平台注释

如果需要使Python程序运行在Windows平台上，需在Python文件的上方加上 #!/usr/bin/python 注释说明。

Python注释除了可以起到说明文档的作用外，还可以进行代码的调试，将一部分代码注释掉，对剩余的代码进行排查，从而找出问题所在，进行代码的完善！

如果要在python2的py文件里面写中文，则必须要添加一行声明文件编码的注释，否则python2会默认使用ASCII编码。

[python] view plain copy

# -*- coding:utf-8 -*-

问题就来了，为什么要如此声明？

首先请参考python的PEP http://python.org/dev/peps/pep-0263/

概要如下

1.必须将编码注释放在第一行或者第二行

2.可选格式有

[python] view plain copy

# coding=

[python] view plain copy

#!/usr/bin/python # -*- coding: -*-

[python] view plain copy

#!/usr/bin/python # vim: set fileencoding=:

但是再往下看，发现其实只要注释里面有coding 和对应的编码就可以了，例如

[python] view plain copy

#!/usr/bin/python # vim: set fileencoding=:

所以搞了半天对最标准的做法也有点糊涂了。

后来想了想，看了下VIM中对python的语法高亮文件，里面把如下的正则表达式确定为编码声明

[plain] view plain copy

\%^.*\?#.*coding[:=]\s*[0-9A-Za-z-_.]\+.*$

对于这个正则有些有点看不懂，但是大致如下必须有coding:[编码]或者coding=[编码]才行，这个应该可以视作为标准的声明方式吧。

但是为什么通常这种方式呢？

[python] view plain copy

# -*- coding:utf-8 -*-

答案在PEP-0263里面有所提及，那就是Emacs等编辑器使用这种方式进行编码声明。

话说PEP里面很多东西都是很值得参考的毕竟可以知道为什么程序这样设计。

坚持每天更新，帮助入门python

小伙伴们，夜深了，给大家讲一讲python注释的吧。大家如果学习过c语言，就会知道程序的注释有什么用。这里多提一句吧，C语言的注释分两种，单行注释和多行注释。C语言的单行注释是最常用的是//，多行注释最常用的是

好了，言归正传我们继续来学习python吧，python常用单行注释是#，常用多行注释是三对单引号''' '''

全理论太抽象，我们一起来看一看例子吧~~~

一、单行注释

单行注释

第一个print

print 'woaipython','hello,world'

打印出来

woaipython hello,world

我们加上注释符#后，

print 'woaipython'#,'hello,world'

打印出来

woaipython

我们可以发现，注释符#后的代码是不会执行的。

二、多行注释

首先，我们来写一个有多行的小程序。

rint 'woaipython'print 'ilovepython'print 'hello'print 'world'print 'python'

我们运行一下这个小程序

我么可以看见打印出了许多数据，接下来我们给第2~4行加上多行注释

print 'woaipython'''' print 'ilovepython'print 'hello'print 'world' '''print 'python'

运行一下

我们可以看见只有第一行和第五行显示了。我们注释掉的2~4行没运行。

总结一下，注释符除了望文生义作注释用、解释程序意思的作用外，还可以把你不想运行也不想删除的程序段给屏蔽起来。

注：刚刚使用的编辑器是gnome桌面自带的gedit编辑器，需要先建一个拓展名为.py文件（命令：touch python.py）。编写完后保存，再使用命令python python.py就可以打印结果了。

每天学一点，积少成多。

后期会循序渐进、由浅入深的讲解python知识，如果想学习python入门，欢迎订阅。

如果还有不明白的小伙伴，欢迎留言评论或私信告诉我。