[已解决]函数注释和函数参数注释

FC的注册很坑

想尽量规范下自己的代码，在网上看到函数注释和函数参数注释的用法，请教下一般的规范是怎么样的？两种都会用吗？用函数参数注释标明参数和返回值类型，在函数注释里写具体的参数描述？

函数注释举例：

1. #!D:/Code/python
   
2. # -*- coding: utf-8 -*-
   
3. # @Time : 2019/8/24 17:58
   
4. # @Author : Johnye
   
5. # @Site :
   
6. # @File : python_practise.py
   
7. # @Software: PyCharm
   
8. 
   
9. 
   
10. def day_learn_python(day, plan, state="finished", *learn_time, **learn_content):
    
11.     """
    
12.     :param day: 固定参数，定义当天日期
    
13.     :param plan: 固定参数，表示当天是否学习python
    
14.     :param state:默认参数,学习计划是否完成 对应默认的参数为”finished“，如果输入参数”unfinished“，
    
15.     :param learn_time: 不定长参数，每天学习的时间 learn_time 离散的数字 每一个数字对应学习的内容  
    
16.     :param learn_content: 关键字参数，每天学习的内容不定
    
17.     :return:返回当天日志，以及完成的情况
    
18.     """
    
19.     datetime = 0
    
20.     for time in learn_time:
    
21.         datetime = int(time) + datetime
    
22.     print("learnday :", day, "\n"
    
23.           "islearnpythontoday:", plan, "\n"
    
24.           "isplanfinished :", state, "\n"
    
25.           "daylylearntime :", datetime, "\n"
    
26.           "other :", learn_content)
    
27.     return day, state
    
28. 
    
29. 30 day1, state1 = day_learn_python("20190824", "learnpython", "finished", 1, 2, 3, learncontent1="pythonfunction",
    
30.                                 learncontent2="pythonclass")
    
31. day2, state2 = day_learn_python("20190823", "learnpython", 1, 2, 3, learncontent1="pythonlist",
    
32.                                 learncontent2="pythontuple")
    
33. print(day1,state1, "\n")
    
34. print(day2,state2, "\n")

复制代码

函数参数注释举例：

1. 
   
2. def greeting(name: str) -> str:
   
3.     return 'Hello ' + name
   

复制代码

最佳答案

月排行榜 / 总排行榜

zltzlt

2019-10-4 16:20:17

可以既在函数中用多行注释 """""" 来标明参数的作用和返回值的具体说明，也在函数定义头标明参数的类型和返回值的类型

跳转到最佳答案楼层

zltzlt

可以既在函数中用多行注释 """""" 来标明参数的作用和返回值的具体说明，也在函数定义头标明参数的类型和返回值的类型

FC的注册很坑

zltzlt 发表于 2019-10-4 16:20
可以既在函数中用多行注释 """""" 来标明参数的作用和返回值的具体说明，也在函数定义头标明参数的类型和返 ...

速度啊，谢谢版主大大