最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

這樣寫python注釋讓代碼更加的優(yōu)雅

 更新時(shí)間:2021年06月02日 09:17:11   作者:autofelix  
任何編程語(yǔ)言都少不了注釋,Python當(dāng)然也不例外,下面這篇文章主要給大家介紹了關(guān)于如何寫python注釋,才能讓你的代碼更加的優(yōu)雅,需要的朋友可以參考下

python這樣注釋,讓你的代碼看起來(lái)更加的優(yōu)雅,是不是常常感覺自己的python代碼寫出來(lái),看起來(lái)特別的亂,雖然可以正常運(yùn)行,但是在優(yōu)雅性上似乎欠缺的很多,這篇文章主要教你,如何讓你的python代碼看起來(lái)更加的優(yōu)雅與美觀,

一、注釋欣賞

這里有一段飛兔小哥哥自己常寫的注釋模版

這里主要分為表頭注釋、類注釋、歡迎語(yǔ)以及方法注釋

表頭注釋會(huì)標(biāo)注這個(gè)項(xiàng)目的名稱、文件名、項(xiàng)目作者、時(shí)間等基礎(chǔ)信息

類注釋會(huì)標(biāo)注這個(gè)類主要用來(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)秀開源框架的代碼注釋

例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ō)明??傊?,大部分編寫函數(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í)現(xiàn)npy/mat文件的保存與讀取

    Python實(shí)現(xiàn)npy/mat文件的保存與讀取

    除了常用的csv文件和excel文件之外,我們還可以通過(guò)Python把數(shù)據(jù)保存文npy文件格式和mat文件格式。本文為大家展示了實(shí)現(xiàn)npy文件與mat文件的保存與讀取的示例代碼,需要的可以參考一下
    2022-04-04
  • Python數(shù)據(jù)分析之pandas比較操作

    Python數(shù)據(jù)分析之pandas比較操作

    比較操作是很簡(jiǎn)單的基礎(chǔ)知識(shí),不過(guò)Pandas中的比較操作有一些特殊的點(diǎn),本文介紹的非常詳細(xì),對(duì)正在學(xué)習(xí)python的小伙伴們很有幫助.需要的朋友可以參考下
    2021-05-05
  • pip search報(bào)錯(cuò)問(wèn)題及解決

    pip search報(bào)錯(cuò)問(wèn)題及解決

    這篇文章主要介紹了pip search報(bào)錯(cuò)問(wèn)題及解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2022-12-12
  • 如何基于Python制作有道翻譯小工具

    如何基于Python制作有道翻譯小工具

    這篇文章主要介紹了如何基于Python制作有道翻譯小工具,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2019-12-12
  • Python學(xué)習(xí)之私有函數(shù),私有變量及封裝詳解

    Python學(xué)習(xí)之私有函數(shù),私有變量及封裝詳解

    私有函數(shù)與私有變量中的私有就是獨(dú)自擁有、不公開、不分享的意思。放到函數(shù)與變量中就是獨(dú)自擁有的函數(shù)與獨(dú)自擁有的變量,并且不公開。本文將通過(guò)示例詳細(xì)講解Python中的私有函數(shù)、私有變量及封裝,感興趣的可以學(xué)習(xí)一下
    2022-03-03
  • pandas DataFrame truediv的具體使用

    pandas DataFrame truediv的具體使用

    本文主要介紹了pandas DataFrame truediv的具體使用,該方法用于執(zhí)行逐元素的真除法操作,下面就來(lái)具體介紹一下,感興趣的可以了解一下
    2025-04-04
  • Windows下Python的Django框架環(huán)境部署及應(yīng)用編寫入門

    Windows下Python的Django框架環(huán)境部署及應(yīng)用編寫入門

    這篇文章主要介紹了Windows下Python的Django框架環(huán)境部署及程序編寫入門,Django在Python的框架中算是一個(gè)重量級(jí)的MVC框架,本文將從程序部署開始講到hellow world web應(yīng)用的編寫,需要的朋友可以參考下
    2016-03-03
  • pycharm2020上部署配置AutoGPT4.0(保姆級(jí)教程)

    pycharm2020上部署配置AutoGPT4.0(保姆級(jí)教程)

    本文主要介紹了pycharm2020上部署配置AutoGPT4.0,文中通過(guò)圖文介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
    2023-06-06
  • Python使用Streamlit快速構(gòu)建一個(gè)數(shù)據(jù)應(yīng)用程序

    Python使用Streamlit快速構(gòu)建一個(gè)數(shù)據(jù)應(yīng)用程序

    Streamlit是一個(gè)開源的Python庫(kù),它允許數(shù)據(jù)科學(xué)家和開發(fā)人員快速創(chuàng)建和分享數(shù)據(jù)應(yīng)用程序,而無(wú)需具備復(fù)雜的Web開發(fā)經(jīng)驗(yàn),本文將介紹Streamlit的基本用法,并通過(guò)一個(gè)實(shí)際案例展示如何快速構(gòu)建一個(gè)簡(jiǎn)單的數(shù)據(jù)應(yīng)用程序,需要的朋友可以參考下
    2025-03-03
  • 使用Python實(shí)現(xiàn)解析HTML的方法總結(jié)

    使用Python實(shí)現(xiàn)解析HTML的方法總結(jié)

    HTML(Hypertext Markup Language)是互聯(lián)網(wǎng)世界中的通用語(yǔ)言,用于構(gòu)建網(wǎng)頁(yè),本文主要為大家介紹了如何使用Python解析HTML,包括各種方法和示例代碼,希望對(duì)大家有所幫助
    2023-11-11

最新評(píng)論

新竹市| 青浦区| 邯郸县| 祁连县| 桃园市| 嘉义县| 全南县| 娄烦县| 通州市| 理塘县| 江津市| 辰溪县| 宣化县| 长寿区| 昂仁县| 上杭县| 沙河市| 大足县| 珲春市| 云梦县| 扬中市| 修武县| 集安市| 绿春县| 朔州市| 辰溪县| 彰武县| 赤壁市| 阿克苏市| 隆化县| 东兰县| 东莞市| 恩施市| 上杭县| 石首市| 洪江市| 丽水市| 巢湖市| 锡林郭勒盟| 海兴县| 扎鲁特旗|