python ——增加文件注释以及函数注释

       毋庸置疑，良好的编码习惯对于学习一门语言很重要，这样可以很好的保持代码可读性以及可维护性。代码的可读性可以通过代码的命名以及注释体现。当然理想的可读性良好的代码是完全没有注释，代码本身已经具有充分的自明性。

       目前对于python遵守的pep8代码规范，需要进一步的了解和熟悉。首先掌握文件注释以及函数注释。

      1.文件注释的添加方式。

      pycharm提供了一个在新建文件自动生成文件头注释的功能，可以实现自动生成运行环境，作者、日期等必要信息，使用比较方便，配置十分简单。 
    

  2.增加函数注释

   自动生成函数注释，包括参数和返回值。使用方法，函数定义时，直接输入三个双引号后回车。

 3.增加文件注释和函数注释的说明如下

#!D:/Code/python
# -*- coding: utf-8 -*-
# @Time : 2019/8/24 17:58
# @Author : Johnye
# @Site :
# @File : python_practise.py
# @Software: PyCharm


def day_learn_python(day, plan, state="finished", *learn_time, **learn_content):
    """
    :param day: 固定参数，定义当天日期
    :param plan: 固定参数，表示当天是否学习python 
    :param state:默认参数,学习计划是否完成 对应默认的参数为”finished“，如果输入参数”unfinished“，
    :param learn_time: 不定长参数，每天学习的时间 learn_time 离散的数字 每一个数字对应学习的内容  
    :param learn_content: 关键字参数，每天学习的内容不定
    :return:返回当天日志，以及完成的情况
    """
    datetime = 0
    for time in learn_time:
        datetime = int(time) + datetime
    print("learnday :", day, "
"
          "islearnpythontoday:", plan, "
"
          "isplanfinished :", state, "
"
          "daylylearntime :", datetime, "
"
          "other :", learn_content)
    return day, state


day1, state1 = day_learn_python("20190824", "learnpython", "finished", 1, 2, 3, learncontent1="pythonfunction",
                                learncontent2="pythonclass")
day2, state2 = day_learn_python("20190823", "learnpython", 1, 2, 3, learncontent1="pythonlist",
                                learncontent2="pythontuple")
print(day1,state1, "
")
print(day2,state2, "
")