如何在python中为多种语言编写docstring

Question

我想为自己创建一个新模块,但我也想让一些同事能够使用它.我开始用英语编写我的文档字符串,但后来我意识到,对于那些不太了解这种语言的人来说,它会使模块变得无用.

我的第一个想法是键入英语和同一文档字符串,西班牙语.但这似乎不对,如果我想让一些俄罗斯朋友也使用它呢？如果我有朋友在世界各地有朋友没有任何共同语言阅读文档怎么办？

在多种语言中编写然后阅读文档字符串的最简单方法是什么？

Answer 1

无法将文档字符串翻译成多种语言，但是您可以通过Sphinx工具创建文档并翻译文档。

Sphinx本身支持生成文档的基于gettext的翻译，请查看 Sphinx国际化指南。

Answer 2

我遇到过同样的问题; 有点：该cmd模块使用文档字符串向最终用户打印帮助，我确实需要一种方法来使用多种语言的文档字符串。我是这样做的：

\n\n

看看这个很棒的教程关于使用 gettext 模块的这使您能够翻译任何 Python 应用程序。我这样使用它：

\n\n

import gettext\ntry:\n    lang = gettext.translation(\'myawesomeapp\', localedir=\'locale\')\n    lang.install()\nexcept FileNotFoundError:\n    _ = lambda x: x\n

\n\n

现在，每当您想要国际化文档字符串时，请遵循以下模式：

\n\n

class MyAwesomeClass:\n    def incredible_method(with_fantastic_args):\n        # Some marvellous code\n\n    incredible_method.__doc__ = _(\'\'\'\\\nPlace here a fabulous docstrig for your incredible method.\nThis will be translated by the gettext module at runtime.\'\'\')\n

\n\n

现在是时候阅读我之前提到的教程了：调用pygettext您的代码，用于poedit创建翻译，并享受乐趣。

\n\n

Adi\xc3\xb3s，paisanos。

\n