py-mo-skill

[jzztf]

编写模块技巧

• 添加模块说明
  • 在模块头部使用三重引号, 第一行作为NAME, 中间隔一行, 之后内容作为DESCRIPTION

    
    #!/usr/bin/env python
    # -*- coding: utf-8 -*-

""" 第一行: 用来简单说明, 模块名称及用途

第二行空起来, 第三行之后可以添加更详细的描述 """

- 为主要函数添加说明
```python
def main():
    """模块主程序

       主要实现方法为:
       1. .....
       2. .....
    """
    ...

• 添加本模块的测试代码

  if __name__ == "__main__":
  """自我测试"""
  main(test)

• 在模块调用中, 可以使用module.__dict__查看所有属性, 也可以使用help(module)查看模块说明信息