零基础如何学好python？Python代码规范之注释

阅读量：5251 次

发布时间：2019-06-14

本文共 2257 字，大约阅读时间需要 7 分钟。

1 ''' 2 在学习过程中有什么不懂得可以加我的 3 python学习交流扣扣qun，934109170 4 群里有不错的学习教程、开发工具与电子书籍。 5 与你分享python企业当下人才需求及怎么从零基础学习好python，和学习什么内容。 6 ''' 7 # 块注释 8 # 块注释 9 #10 # 块注释11 # 块注释

1.2、行注释

至少使用两个空格和语句分开，注意不要使用无意义的注释

1 # 正确的写法2 x = x + 1  # 边框加粗一个像素3 4 # 不推荐的写法(无意义的注释)5 x = x + 1 # x加1

1.3、建议

在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释

比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性

1 app = create_app(name, options) 2  3  4 # ===================================== 5 # 请勿在此处添加 get post等app路由行为 !!! 6 # ===================================== 7  8  9 if __name__ == '__main__':10     app.run()

2、文档注释（Docstring）

作为文档的Docstring一般出现在模块头部、函数和类的头部，这样在python中可以通过对象的__doc__对象获取文档. 编辑器和IDE也可以根据Docstring给出自动提示.

文档注释以 """ 开头和结尾, 首行不换行, 如有多行, 末行必需换行, 以下是Google的docstring风格示例

1 # -*- coding: utf-8 -*- 2 """Example docstrings. 3  4 This module demonstrates documentation as specified by the `Google Python 5 Style Guide`_. Docstrings may extend over multiple lines. Sections are created 6 with a section header and a colon followed by a block of indented text. 7  8 Example: 9     Examples can be given using either the ``Example`` or ``Examples``10     sections. Sections support any reStructuredText formatting, including11     literal blocks::12 13         $ python example_google.py14 15 Section breaks are created by resuming unindented text. Section breaks16 are also implicitly created anytime a new section starts.17 """

不要在文档注释复制函数定义原型, 而是具体描述其具体内容, 解释具体参数和返回值等

1 #  不推荐的写法(不要写函数原型等废话) 2 def function(a, b): 3     """function(a, b) -> list""" 4     ... ... 5  6  7 #  正确的写法 8 def function(a, b): 9     """计算并返回a到b范围内数据的平均值"""10     ... ...11 对函数参数、返回值等的说明采用numpy标准, 如下所示12 def func(arg1, arg2):13     """在这里写函数的一句话总结(如: 计算平均值).14 15     这里是具体描述.16 17     参数18     ----------19     arg1 : int20         arg1的具体描述21     arg2 : int22         arg2的具体描述23 24     返回值25     -------26     int27         返回值的具体描述28 29     参看30     --------31     otherfunc : 其它关联函数等...32 33     示例34     --------35     示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行36 37     >>> a=[1,2,3]38     >>> print [x + 3 for x in a]39     [4, 5, 6]40     """