简明Python docstrings

Posted 董昱锦

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了简明Python docstrings相关的知识,希望对你有一定的参考价值。

 1 #!/usr/bin/env python
 2 #coding:utf-8
 3 def print_max(x,y):
 4     ‘‘‘Prints the maximum of two numbers.打印两个数值中的最大数。
 5         The two values must be integers.这两个数都应该是整数‘‘‘
 6 #如果可能,将其转换至整数类型
 7 x=int(x)
 8 y=int(y)
 9 
10 if x>y:
11     print(x,is maxinum)
12 
13 else:
14     print(y,is maxinum)
15 
16 print_max(3, 5)
17 print(print_max.__doc__)
1 5 is maximum
2 Prints the maximum of two numbers.
3         The two values must be integers.

 

以上是关于简明Python docstrings的主要内容,如果未能解决你的问题,请参考以下文章

python代码docstring生成文档之sphinx

如何更改pycharm python docstring颜色

Python测试框架doctest

什么放在python模块docstring? [关闭]

pycahrm使用docstrings来指定变量类型返回值类型函数参数类型

python 使用none和docstrings指定动态默认参数