概述

秦人不暇自哀,而后人哀之;后人哀之而不鉴之,亦使后人而复哀后人也! –论面向文档编程的重要性

如不雅想看见识一小我写代码的功力，注释其实是区分老司机和小鲜肉的一个明显的分界线(有没有不雅察碘晾髑公司的引导根本都在开会或者写文档)，平日情况下老司机的文档量与代码量是1：1的比例，而新人往往认为写完功能模块就已经可以完成义务了。临盆情况中须要面对实际中大年夜量复杂的营业逻辑和数据校验并与各方对接，文档质量和代码质量就被晋升到了雷同的高度。很多人没有写注释的习惯，大年夜多半不是因为懒惰，一方面是没有意识到写文档的好处，另一方面是不懂得这方面的对象。毕竟大年夜治理上依附于人的主动性是远不如依附于对象有效的。本文介绍若何应用Python注释晋升文档书写的质量以及效力的小技能。

Python

在实际临盆中，机械进修工作如今看起来，日间像是个算法工程师的活，晚上就变成运维+测试了。Python 一向以来也都受到测试工程师和运维工程师的偏爱，下面是几个经典的注释活用case。

用注释写单位测试:doctest

一个奇妙的方法可所以经由过程doctest，用docstring注释的方法来完成单位测试，因为每个办法def下面都先跟着一段测试用例，然后紧跟着就是代码正文，如许一来很便利我们测试现有代码的质量，另一方霉Ｖ便于修改。

举个例子：

def factorial(n): 
 
    """Return the factorial of n, an exact integer >= 0. 
 
  
 
    >>> [factorial(n) for n in range(6)] 
 
    [1, 1, 2, 6, 24, 120] 
 
    >>> factorial(30) 
 
    265252859812191058636308480000000 
 
    >>> factorial(-1) 
 
    Traceback (most recent call last): 
 
        ... 
 
    ValueError: n must be >= 0 
 
  
 
    Factorials of floats are OK, but the float must be an exact integer: 
 
    >>> factorial(30.1) 
 
    Traceback (most recent call last): 
 
        ... 
 
    ValueError: n must be exact integer 
 
    >>> factorial(30.0) 
 
    265252859812191058636308480000000 
 
  
 
    It must also not be ridiculously large: 
 
    >>> factorial(1e100) 
 
    Traceback (most recent call last	
			
 1/5    1 2 3 4 5 下一页 尾页
	
			

　　推荐阅读
　　人工智能行业薪酬曝光，是时候转行了
            
            人工智能可谓是今朝最热点的行业，大年夜走在前沿的科技公司，到尽力立异的传统行业，几乎都想把握这个新“风口”。而人工智能的核心就是人才，热点的行业通平平易近味着工作机>>>详细阅读


本文标题：Python开发者面向文档编程的正确姿势
地址：http://www.17bianji.com/lsqh/36964.html
 1/2    1