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, "\n"
          "islearnpythontoday:", plan, "\n"
          "isplanfinished :", state, "\n"
          "daylylearntime :", datetime, "\n"
          "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, "\n")
print(day2,state2, "\n")