這樣寫(xiě)python注釋讓代碼更加的優(yōu)雅
python這樣注釋,讓你的代碼看起來(lái)更加的優(yōu)雅,是不是常常感覺(jué)自己的python代碼寫(xiě)出來(lái),看起來(lái)特別的亂,雖然可以正常運(yùn)行,但是在優(yōu)雅性上似乎欠缺的很多,這篇文章主要教你,如何讓你的python代碼看起來(lái)更加的優(yōu)雅與美觀,
一、注釋欣賞
這里有一段飛兔小哥哥自己常寫(xiě)的注釋模版
這里主要分為表頭注釋、類(lèi)注釋、歡迎語(yǔ)以及方法注釋
表頭注釋會(huì)標(biāo)注這個(gè)項(xiàng)目的名稱、文件名、項(xiàng)目作者、時(shí)間等基礎(chǔ)信息
類(lèi)注釋會(huì)標(biāo)注這個(gè)類(lèi)主要用來(lái)做什么的
而方法注釋則表示當(dāng)前方法的作用
#!/usr/bin/env python # encoding: utf-8 ''' #------------------------------------------------------------------- # CONFIDENTIAL --- CUSTOM STUDIOS #------------------------------------------------------------------- # # @Project Name : the desc of project # # @File Name : main.py # # @Programmer : autofelix # # @Start Date : 2021/06/01 12:42 # # @Last Update : 2021/06/01 12:42 # #------------------------------------------------------------------- ''' import requests, os, platform, time from Crypto.Cipher import AES import multiprocessing from retrying import retry class M3u8: ''' This is a main Class, the file contains all documents. One document contains paragraphs that have several sentences It loads the original file and converts the original file to new content Then the new content will be saved by this class ''' def __init__(self): ''' Initial the custom file by self ''' self.encrypt = False def hello(self): ''' This is a welcome speech :return: self ''' print("*" * 50) print(' ' * 15 + 'm3u8鏈接下載小助手') print(' ' * 5 + '作者: autofelix Date: 2021-06-01 12:42') print(' ' * 10 + '適用于非加密 | 加密鏈接') print("*" * 50) return self def run(self): pass if __name__ == '__main__': M3u8().hello().run()
附:python函數(shù)注釋規(guī)范
首先來(lái)兩段優(yōu)秀開(kāi)源框架的代碼注釋
例1 tornado.web.RequestHandler的get_arguments函數(shù).
def get_argument(self, name, default=_ARG_DEFAULT, strip=True): """Returns the value of the argument with the given name. If default is not provided, the argument is considered to be required, and we raise a `MissingArgumentError` if it is missing. If the argument appears in the url more than once, we return the last value. The returned value is always unicode. """ return self._get_argument(name, default, self.request.arguments, strip)
例2 requests的get函數(shù)
def get(url, params=None, **kwargs): """Sends a GET request. :param url: URL for the new :class:`Request` object. :param params: (optional) Dictionary or bytes to be sent in the query string for the :class:`Request`. :param \*\*kwargs: Optional arguments that ``request`` takes. :return: :class:`Response <Response>` object :rtype: requests.Response """ kwargs.setdefault('allow_redirects', True) return request('get', url, params=params, **kwargs)
對(duì)比下例1和例2, tornado框架的函數(shù)傾向與給出函數(shù)的用途說(shuō)明,而不提供具體的輸入?yún)?shù)說(shuō)明,并且相對(duì)來(lái)說(shuō)函數(shù)名字也是淺顯易懂,而requests庫(kù)看起來(lái)比較簡(jiǎn)潔一點(diǎn),具體的輸入和輸出都給的很完整,看起來(lái)很是賞心悅目,所以我個(gè)人更偏向于例2的注釋,當(dāng)然,也有將例1和例2注釋特點(diǎn)結(jié)合起來(lái)的庫(kù),比如tensorflow庫(kù),因?yàn)樯婕暗妮斎雲(yún)?shù)以及函數(shù)較為復(fù)雜,因此輸入?yún)?shù)和函數(shù)原理有較為詳盡的說(shuō)明??傊蟛糠志帉?xiě)函數(shù)的時(shí)候參考例2的注釋方式,代碼也看起來(lái)較為優(yōu)雅,而遇到比較復(fù)雜的情況,則可以參考例1加上必要的函數(shù)詳細(xì)說(shuō)明。
總結(jié)
到此這篇關(guān)于python注釋的文章就介紹到這了,更多相關(guān)python注釋內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Python同時(shí)向控制臺(tái)和文件輸出日志logging的方法
這篇文章主要介紹了Python同時(shí)向控制臺(tái)和文件輸出日志logging的方法,涉及Python日志模塊的相關(guān)使用技巧,需要的朋友可以參考下2015-05-05selenium常用API的使用過(guò)程記錄(包括自動(dòng)登錄)
selenium是一個(gè)自動(dòng)測(cè)試工具,它可以幫我通過(guò)代碼去實(shí)現(xiàn)驅(qū)動(dòng)瀏覽器自動(dòng)執(zhí)行相應(yīng)的操作,所以我們也可以用它來(lái)做爬蟲(chóng),主要使用selenium的目的是為了跳過(guò)登錄驗(yàn)證,這篇文章主要介紹了selenium的使用過(guò)程記錄,已經(jīng)常用API接口(包括自動(dòng)登錄)2024-02-02使用python獲取PDF頁(yè)面的大小、方向和旋轉(zhuǎn)角度
在文檔管理和自動(dòng)化領(lǐng)域,了解PDF文檔的內(nèi)在屬性(如頁(yè)面大小、方向和旋轉(zhuǎn)角度)對(duì)于確保一致的文檔處理和布局保真度至關(guān)重要,因?yàn)樗鼈冎苯佑绊懳臋n的可讀性和用戶體驗(yàn),本文將展示如何使用Python代碼獲取PDF文檔中頁(yè)面的大小、方向和旋轉(zhuǎn)角度,需要的朋友可以參考下2024-09-09基于OpenCV實(shí)現(xiàn)視頻循環(huán)播放
這篇文章主要為大家介紹了如何利用OpenCV實(shí)現(xiàn)視頻的循環(huán)播放,本文為大家提供了兩種方式,一個(gè)是利用Python語(yǔ)言實(shí)現(xiàn),一個(gè)是利用C++語(yǔ)言實(shí)現(xiàn),需要的可以參考一下2022-02-02Python的Flask框架標(biāo)配模板引擎Jinja2的使用教程
Jinja2是Python世界的一款高人氣template engine,是許多開(kāi)源Web框架的選擇,包括Flask這樣的明星級(jí)項(xiàng)目,這里我們就來(lái)共同學(xué)習(xí)Python的Flask框架標(biāo)配模板引擎Jinja2的使用教程2016-07-07Python3 log10()函數(shù)簡(jiǎn)單用法
在本文中我們給大家整理了關(guān)于Python3中l(wèi)og10()函數(shù)的基本用法和相關(guān)知識(shí)點(diǎn),需要的可以學(xué)習(xí)下。2019-02-02詳解Python數(shù)據(jù)分析--Pandas知識(shí)點(diǎn)
這篇文章主要介紹了Python數(shù)據(jù)分析--Pandas知識(shí)點(diǎn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-03-03Python驗(yàn)證的50個(gè)常見(jiàn)正則表達(dá)式
這篇文章主要給大家介紹了關(guān)于利用Python驗(yàn)證的50個(gè)常見(jiàn)正則表達(dá)式的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-03-03