“優(yōu)秀的代碼不需要文檔”，這句話雖然說的有些夸張的成份，但是也并無一定道理。優(yōu)秀的項(xiàng)目中的代碼，注釋占的比重是相當(dāng)大的。比方tornado框架中的代碼：

classHTTPServer(TCPServer,Configurable,

httputil.HTTPServerConnectionDelegate):

r"""Anon-blocking,single-threadedHTTPserver.

Aserverisdefinedbyasubclassof.HTTPServerConnectionDelegate,

or,forbackwardscompatibility,acallbackthattakesan

.HTTPServerRequestasanargument.Thedelegateisusuallya

tornado.web.Application.

HTTPServersupportskeep-aliveconnectionsbydefault

(automaticallyforHTTP/1.1,orforHTTP/1.0whentheclient

requestsConnection:keep-alive).

IfxheadersisTrue,wesupportthe

X-Real-Ip/X-Forwarded-Forand

X-Scheme/X-Forwarded-Protoheaders,whichoverridethe

remoteIPandURIscheme/protocolforallrequests.Theseheaders

areusefulwhenrunningTornadobehindareverseproxyorload

balancer.Theprotocolargumentcanalsobesettohttps

ifTornadoisrunbehindanSSL-decodingproxythatdoesnotsetoneof

thesupportedxheaders.

TomakethisserverserveSSLtraffic,sendthessl_optionskeyword

argumentwithanssl.SSLContextobject.Forcompatibilitywitholder

versionsofPythonssl_optionsmayalsobeadictionaryofkeyword

argumentsforthessl.wrap_socketmethod.::

ssl_ctx=ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)

ssl_ctx.load_cert_chain(os.path.join(data_dir,"mydomain.crt"),

os.path.join(data_dir,"mydomain.key"))

HTTPServer(applicaton,ssl_options=ssl_ctx)

HTTPServerinitializationfollowsoneofthreepatterns(the

initializationmethodsaredefinedontornado.tcpserver.TCPServer):

1.~tornado.tcpserver.TCPServer.listen:simplesingle-process::

server=HTTPServer(app)

server.listen(8888)

IOLoop.current().start()

Inmanycases,tornado.web.Application.listencanbeusedtoavoid

theneedtoexplicitlycreatetheHTTPServer.

2.~tornado.tcpserver.TCPServer.bind/~tornado.tcpserver.TCPServer.start:

simplemulti-process::

server=HTTPServer(app)

server.bind(8888)

server.start(0)#Forksmultiplesub-processes

IOLoop.current().start()

Whenusingthisinterface,an.IOLoopmust*not*bepassed

totheHTTPServerconstructor.~.TCPServer.startwillalwaysstart

theserveronthedefaultsingleton.IOLoop.

3.~tornado.tcpserver.TCPServer.add_sockets:advancedmulti-process::

sockets=tornado.netutil.bind_sockets(8888)

tornado.process.fork_processes(0)

server=HTTPServer(app)

server.add_sockets(sockets)

IOLoop.current().start()

The~.TCPServer.add_socketsinterfaceismorecomplicated,

butitcanbeusedwithtornado.process.fork_processesto

giveyoumoreflexibilityinwhentheforkhappens.

~.TCPServer.add_socketscanalsobeusedinsingle-process

serversifyouwanttocreateyourlisteningsocketsinsome

wayotherthantornado.netutil.bind_sockets.

..versionchanged::4.0

Addeddecompress_request,chunk_size,max_header_size,

idle_connection_timeout,body_timeout,max_body_size

arguments.Addedsupportfor.HTTPServerConnectionDelegate

instancesasrequest_callback.

..versionchanged::4.1

.HTTPServerConnectionDelegate.start_requestisnowcalledwith

twoarguments(server_conn,request_conn)(inaccordancewiththe

documentation)insteadofone(request_conn).

..versionchanged::4.2

HTTPServerisnowasubclassoftornado.util.Configurable.

"""

def__init__(self,*args,**kwargs):

#Ignoreargsto__init__;realinitializationbelongsin

#initializesincewe'reConfigurable.(there'ssomething

#weirdininitializationorderbetweenthisclass,

#Configurable,andTCPServersowecan'tleave__init__out

#completely)

pass

上面的注釋包含了：類的說明、例子、版本主要改動(dòng)。

優(yōu)秀的代碼風(fēng)格：看到名字就能知道它是用來干什么的(顧名思義)、結(jié)構(gòu)清晰、代碼風(fēng)格統(tǒng)一(命名規(guī)則、格式)

這些優(yōu)秀的特質(zhì)都是為了：可讀性、容易理解。正如：代碼主要是給人看的，讓計(jì)算機(jī)運(yùn)行是次要的

如果是在閱讀了不好的代碼，如果你心里在罵：“這代碼簡直是一坨

所以，自己的優(yōu)秀的編碼風(fēng)格也是成為一個(gè)合格的程序員必備的一項(xiàng)技能(面試要求會有這一項(xiàng))，通過閱讀代碼學(xué)習(xí)，模仿優(yōu)秀的代碼風(fēng)格，有助于自己寫出‘漂亮’、整潔的代碼。

以上內(nèi)容為大家介紹了python閱讀代碼有助于養(yǎng)成優(yōu)秀的代碼風(fēng)格，希望對大家有所幫助，如果想要了解更多Python相關(guān)知識，請關(guān)注IT培訓(xùn)機(jī)構(gòu):千鋒教育。