pycharm的docstring文档字符串风格

网友投稿 1161 2022-05-29

设置位置:

pycharm的docstring文档字符串风格

Tools -> Python Integrated Tools -> Docstrings -> Docstring format

五种风格:

Plain

reStructuredText

Numpy

Google

Epytext

风格示例

# Plain def foo1(a, b): """ """ return a+b # reStructuredText def foo2(a, b): """ :param a: :param b: :return: """ return a+b # Numpy def foo3(a, b): """ Parameters ---------- a b Returns ------- """ return a+b # Google def foo4(a, b): """ Args: a: b: Returns: """ return a + b # Epytext def foo(a, b): """ @param a: @param b: @return: """ return a+b

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:Python编程:使用doctest进行文档测试
下一篇:【PM】产品需求文档PRD的一般格式
相关文章