您现在的位置是：首页>全部文章全部文章

python多行注释规范

2021年1月16日 22:05【python】【规范】【注释】268人已围观

## reST

这是现在流行的一种风格，reST风格，Sphinx的御用格式。
```python
"""
This is a reST style.

:param param1: this is a first param
:param param2: this is a second param
:returns: this is a description of what is returned
:raises keyError: raises an exception
"""
```

## Epytext

这是曾经比较流行的一直类似于javadoc的风格。

```python
"""
This is a javadoc style.

@param param1: this is a first param
@param param2: this is a second param
@return: this is a description of what is returned
@raise keyError: raises an exception
"""
```

## Google风格

```python
"""
This is a groups style docs.

Parameters:
  param1 - this is the first param
  param2 - this is a second param

Returns:
  This is a description of what is returned

Raises:
  KeyError - raises an exception
"""
```

## Numpydoc (Numpy风格)

```python
"""
My numpydoc description of a kind
of very exhautive numpydoc format docstring.

Parameters
----------
first : array_like
  the 1st param name `first`
second :
  the 2nd param
third : {'value', 'other'}, optional
  the 3rd param, by default 'value'

Returns
-------
string
  a value in a string

Raises
------
KeyError
  when a key error
OtherError
  when an other error
"""
```

上一篇：1.两数之和

下一篇：单例模式之Python实现