python之为使用 python 脚本添加注释_编程设计

首先，我不知道是否有一些好的规则或惯例可以为 Python 脚本的使用添加注释。这是我的问题。

在 python 脚本中，包含函数定义，以及下面的部分 if __name__ == '__main__':，我应该在哪里添加注释以下部分的用法 if __name__ == '__main__':: 在脚本低于 shebang，或低于 if __name__ == '__main__':?

例如，

#!/usr/bin/env python                              
 
 
import argparse 
 
 
def myfun(): 
    ... 
 
if __name__ == '__main__': 
 
    parser = argparse.ArgumentParser(description='A script of writing comment of usage') 
    parser.add_argument('--in', dest='in', help='an input file') 
    parser.add_argument('--out', dest='out', help='an output file') 
    args = parser.parse_args()

我对下面部分的用法的评论 if __name__ == '__main__': 是调用脚本的例子:

''' Example:                                                                                                                                                    
myscript.py --in infile --out outfile 
'''

我应该在脚本的什么地方添加它？

在评论脚本的使用时，除了提供示异常(exception)，我还要补充什么？我认为选项在 parser.add_argument()，脚本的目的不言自明在 argparse.ArgumentParser() 中？

例如，从上面的例子来看，下面这些是否足够解释脚本的目的和选项？
```
    parser = argparse.ArgumentParser(description='A script of writing comment of usage') 
 
    parser.add_argument('--in', dest='in', help='an input file') 
    parser.add_argument('--out', dest='out', help='an output file') 
```

谢谢。

请您参考如下方法:

标准的 Python 模块/脚本文档是这样完成的。

#! /usr/bin/env python  
 
""" 
Leave your docs here. Describe the behaviour of your main function. E.g.  
The script does blah-blah...  
Standard usage: myscript.py --in infile --out outfile 
""" 
 
import ...

除此之外，您还可以修改 argparse 中的 help 参数以显示标准用法。顺便说一句，if __name__ == "__main__" 行与 master 函数结合使用(通常称为 main)。重点是将所有处理留在 main 函数中，例如

#! /usr/bin/env python   
 
""" 
The script does blah-blah... 
Standard usage: ... 
""" 
 
def foo(args...): 
    ... 
 
def ham(args...): 
    ... 
 
def main(): 
   # do something with foo and ham  
 
if __name__ == "__main__": 
   main()