“优秀的代码不需要文档”，这句话虽然说的有些夸张的成份，但是也并无一定道理。优秀的项目中的代码，注释占的比重是相当大的。比方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

上面的注释包含了：类的说明、例子、版本主要改动。

优秀的代码风格：看到名字就能知道它是用来干什么的(顾名思义)、结构清晰、代码风格统一(命名规则、格式)

这些优秀的特质都是为了：可读性、容易理解。正如：代码主要是给人看的，让计算机运行是次要的

如果是在阅读了不好的代码，如果你心里在骂：“这代码简直是一坨

所以，自己的优秀的编码风格也是成为一个合格的程序员必备的一项技能(面试要求会有这一项)，通过阅读代码学习，模仿优秀的代码风格，有助于自己写出‘漂亮’、整洁的代码。

以上内容为大家介绍了python阅读代码有助于养成优秀的代码风格，希望对大家有所帮助，如果想要了解更多Python相关知识，请关注IT培训机构:千锋教育。

上一篇

Python的动态类型

下一篇

Python什么是函数式编程?