python 增加檔案注釋以及函式注釋

2022-05-09 09:48:12 字數 2058 閱讀 3086

毋庸置疑,良好的編碼習慣對於學習一門語言很重要,這樣可以很好的保持**可讀性以及可維護性。**的可讀性可以通過**的命名以及注釋體現。當然理想的可讀性良好的**是完全沒有注釋,**本身已經具有充分的自明性。

目前對於python遵守的pep8**規範,需要進一步的了解和熟悉。首先掌握檔案注釋以及函式注釋。

1.檔案注釋的新增方式。

pycharm提供了乙個在新建檔案自動生成檔案頭注釋的功能,可以實現自動生成執行環境,作者、日期等必要資訊,使用比較方便,配置十分簡單。 

2.增加函式注釋

自動生成函式注釋,包括引數和返回值。使用方法,函式定義時,直接輸入三個雙引號後回車。

3.增加檔案注釋和函式注釋的說明如下

1

#!d:/code/python2#

-*- coding: utf-8 -*-3#

@time : 2019/8/24 17:584#

@author : johnye5#

@site :6#

@file : python_practise.py7#

@software: pycharm89

10def 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

20for time in

learn_time:

21 datetime = int(time) +datetime

22print("

learnday :

", day, "\n"

23"islearnpythontoday:

", plan, "\n"

24"isplanfinished :

", state, "\n"

25"daylylearntime :

", datetime, "\n"

26"other :

", learn_content)

27return

day, state

2829

30 day1, state1 = day_learn_python("

20190824

", "

learnpython

", "

finished

", 1, 2, 3, learncontent1="

pythonfunction",

31 learncontent2="

pythonclass")

32 day2, state2 = day_learn_python("

20190823

", "

learnpython

", 1, 2, 3, learncontent1="

pythonlist",

33 learncontent2="

pythontuple")

34print(day1,state1, "\n"

)35print(day2,state2, "

\n")

ORACLE中給表 列增加注釋以及讀取注釋

在oracle中給表 列增加注釋以及讀取注釋 1 給表填加注釋 sql comment on table 表名 is 表注釋 2 給列加注釋 sql comment on column 表.列 is 列注釋 3 讀取表注釋 sql select from user tab comments wher...

Python中sort以及sorted函式初探

help on built in function sorted in module builtin sorted sorted iterable,cmp none,key none,reverse false new sorted list help on built in function so...

vim配置檔案以及整段注釋 反注釋

set smarttab 設定tab符u 度為4個空 set tabstop 4 設定m lg j 縮 u 度為4個空 set shiftwidth 4 設定tab符g j 轉m 為空 set expandtab 設定y c 縮 le vo i縮 v ozautoindent,cindent,ind...