手册页和Python脚本的帮助之间有什么区别？
手册页和Python脚本的帮助之间有什么区别？
提问于 2017-10-02 13:35:55
我目前正在为我工作的公司制定一些标准操作程序。我从非常小的例子开始，比如脚本。目前有几个脚本正在用不同的语言编写。其想法是在开发工具时坚持每种语言的最佳实践。对于企业来说，真正的问题是如何使用脚本以及脚本的用途是通过口头传递的。
因此，对于每个存储库，我将提供一个SOP：
- 用户手册
- 编码实践。
- 版本控制最佳实践。
- 帮助文档
从#4开始，我知道在Python中可以使用嵌入到代码中的help docstring来开发脚本。我当时想知道，这种方法和实际的手册页有什么区别？
这里的大多数开发人员都在使用Windows。
在最佳实践方面，这两种方法都应该是必需的，或者仅仅是嵌入式Python --帮助文档？
回答 1
Software Engineering用户
回答已采纳
发布于 2017-10-03 14:23:15
我想编写Python脚本的推荐方法是使用ArgumentParser (请参阅https://docs.python.org/2/howto/argparse.html#conflicting-options上的最后一个示例)：
$ python prog.py --help
usage: prog.py [-h] [-v | -q] x y
calculate X to the power of Y
positional arguments:
x the base
y the exponent
optional arguments:
-h, --help show this help message and exit
-v, --verbose
-q, --quiet这种方法和实际手册页有什么区别？这里的大多数开发人员都在使用Windows。
手册页是类Unix系统的标准。因此，对于这个特定的Python脚本情况，我发现最好使用Python社区推荐的标准作为文档。
页面原文内容由Software Engineering提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://softwareengineering.stackexchange.com/questions/358454
复制相关文章
相似问题
腾讯云开发者
