乐商网_商业资讯网站
您当前的位置 : 乐商网  >  时尚
Python随笔11:Python代码规范之注释和文档
2020-03-28 06:16:22 来源:互联网 阅读:-

引言:每天习以为常的Python代码,是否符合Python的规范?想写出Pytonic风格的代码,却不知道如何开始?

这个“Python代码规范”系列将会解决这些规范性的问题。

注:本代码规范基于PEP8, 在PEP8的基础上做了一些改动。



Python代码规范


注释和文档

代码注释和文档(docstring)的规范,参考并综合了PEP257、Google Python Style Guide和Numpy的文档标准。


注释

  • 单行注释和多行注释,请参考Python随笔10:Python代码规范之简明概述
  • 在代码的关键部分(或比较复杂的地方),能写注释的要尽量写注释。
  • 比较重要的注释段,使用多个等号隔开,可以更加醒目,突出重要性。
app = create_app(name, options)


# =====================================
# 请勿在此处添加 get post等app路由行为 !!!
# =====================================


if __name__ == '__main__':
app.run()


文档注释(Docstring)

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

  • 文档注释以 """ 开头和结尾,首行不换行,如有多行,末行必需换行,以下是Google的docstring风格示例:
# -*- coding: utf-8 -*-
"""Example docstrings.

This module demonstrates documentation as specified by the `Google Python
Style Guide`_. Docstrings may extend over multiple lines. Sections are created
with a section header and a colon followed by a block of indented text.

Example:
Examples can be given using either the ``Example`` or ``Examples``
sections. Sections support any reStructuredText formatting, including
literal blocks::

$ python example_google.py

Section breaks are created by resuming unindented text. Section breaks
are also implicitly created anytime a new section starts.
"""
  • 不要在文档注释复制函数定义原型,而是具体描述其具体内容,解释具体参数和返回值等:
# 不推荐的写法(不要写函数原型等废话)
def function(a, b):
"""function(a, b) -> list"""
... ...


# 正确的写法
def function(a, b):
"""计算并返回a到b范围内数据的平均值"""
... ...
  • 对函数参数、返回值等的说明采用numpy标准,如下所示:
def func(arg1, arg2):
"""在这里写函数的一句话总结(如: 计算平均值).

这里是具体描述.

参数
----------
arg1 : int
arg1的具体描述
arg2 : int
arg2的具体描述

返回值
-------
int
返回值的具体描述

参看
--------
otherfunc : 其它关联函数等...

示例
--------
示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行

>>> a=[1,2,3]
>>> print [x + 3 for x in a]
[4, 5, 6]
"""
  • 文档注释不限于中英文,但不要中英文混用。
  • 文档注释不是越长越好,通常一两句话能把情况说清楚即可。
  • 模块、公有类、公有方法,能写文档注释的,应该尽量写文档注释。

To be continued.

推荐阅读:苹果手表维修

频道推荐
  • 这4种小吃让东北人难以下咽,南方人却吃得津津有味
    这4种小吃让东北人难以下咽,南方人却吃得津津

    有句俗话是那么说的,人们辜负什么东西也不能辜负美食,是因为能够带给人们许多美好幸福的回忆,无论从什么方面讲,每每品尝到好吃的东西时,什么烦忧在这期间一定会化为乌...

    2020-02-12
  • 四家最出名的麻辣烫,杨国福上榜,你吃过几家?
    四家最出名的麻辣烫,杨国福上榜,你吃过几家?

    我们非常喜欢吃很多的小吃,比如麻辣拌麻辣烫以及各种凉面皮。这些隐藏在很多小巷子里的小吃是大家非常喜欢的食物,中国的小吃确实有很多,但是今天我们要讲的是四家最出名...

    2020-02-12
  • 王健林爱吃的一种饺子,很少人吃过,网友:有钱人口味就是不一样
    王健林爱吃的一种饺子,很少人吃过,网友:有钱

    说到饺子,里面的门道也不少,饺子看起来制作简单,做法是多样的,其中饺子的包法就有很多种,里面的馅料更是多种多样,可以选择各种各样的肉和蔬菜进行组合,只要你喜欢就...

    2020-02-12
  • 中国最好吃的4种蟹,大闸蟹只是“垫底”, 有种2000元1只
    中国最好吃的4种蟹,大闸蟹只是“垫底”, 有

    海边有很多的海鲜,价格相对来说还是比较便宜的,在海边见的最多的就是螃蟹了,各种各样的螃蟹,在我们的印象中,最贵的螃蟹就是帝王蟹,因为它的个头特别大,而且在中国是...

    2020-02-12
  • 它比“小龙虾”还受宠,味道鲜美,曾卖5元一斤,现想吃都买不起
    它比“小龙虾”还受宠,味道鲜美,曾卖5元一斤

    说起吃海鲜的话,小七第一个想到的,那就是小龙虾了,毕竟这些年,小龙虾成为了夜宵摊上面的销量王,以前记得只卖几元钱一斤,但是现在卖到了几十元一斤,大家都不嫌弃贵,...

    2020-02-12
  • 同样是茶,在18个国家竟有18种吃法
    同样是茶,在18个国家竟有18种吃法

    同样是茶,在18个国家竟然有18种吃法!!同样是茶,这吃法差别咋就这么大呢!!下面小编让大家了解一下18个不同的国家是怎么品茶的。1.日本用天然石磨碾磨成超微粉...

    2020-02-12