main()函数是否需要编写文档字符串（docstring）？

我之前一直持这样的观点：通过if __name__ == '__main__':触发调用的main()函数，完全没必要写docstring。理由很简单：

• docstring的主要使用场景是在Python内部调用函数时查看（比如用help()函数），但main()通常都是从命令行启动脚本时才会执行，这时候根本没机会访问到它的文档字符串
• main()作为脚本的入口函数，作用本来就广为人知，好像不需要额外的文档说明

不过后来翻PEP8规范的时候发现，里面明确要求：

应为所有公共模块、函数、类和方法编写docstring。文档字符串并非必...（原文此处未完成）

其实仔细想想，这个规范也有它的道理：万一有其他开发者需要导入你的模块，直接调用main()函数呢？这时候docstring就能帮他们快速理解这个函数的作用、参数和返回值。而且保持所有公共函数都有docstring的习惯，也能让代码风格更统一，可读性更强。

内容的提问来源于stack exchange，提问作者ari