Python 代码如果要在注释中描述一个接口的返回值，是否有什么标准格式？

推荐学习书目

› Learn Python the Hard Way

Python Sites

› PyPI - Python Package Index

› http://diveintopython.org/toc/index.html

› Pocoo

值得关注的项目

› PyPy

› Celery

› Jinja2

› Read the Docs

› gevent

› pyenv

› virtualenv

› Stackless Python

› Beautiful Soup

› 结巴中文分词

› Green Unicorn

› Sentry

› Shovel

› Pyflakes

› pytest

Python 编程

› pep8 Checker

Styles

› PEP 8

› Google Python Style Guide

› Code Style from The Hitchhiker's Guide

This topic created in 3027 days ago, the information mentioned may be changed or developed.

返回值

Python

注释

代码

16 replies • 2018-09-04 11:44:58 +08:00

monkeylyf

Jul 27, 2018

可以参考 google 的 python coding style: https://github.com/google/styleguide/blob/gh-pages/pyguide.md#383-functions-and-methods
以前的公司也用过这个
“”“ Summary.

Details.

:arg1, int: i do this
:arg2, str: i do that
:return, list: i do both
"""
仅供参考

hlwjia

Jul 27, 2018

现在做的类似于 @monkeylyf 写的，就是标点符号不同，格式一致

startar

Jul 27, 2018 via Android

那肯定使用标准的 docstring 格式啊

startar

Jul 27, 2018 via Android

@monkeylyf google 这个其实就是规定使用 python docstring。用这个的话可以让 help()函数显示你的注释，还可以用 sphinx 自动生成文档

guyskk0x0

Jul 27, 2018 via Android

1. docstring，主要有 numpy, google, sphinx 三种风格，sphinx 工具支持最完善，个人喜欢 google 风格
2. 用装饰器 @params @returns 格式自己定，很方便生成其他格式
3. 类型注解，标准格式（ typing ）或者自己定格式，也很方便生成其他格式