对于开源项目，如何快捷的提供英文文档

[cesign]

自己做了个开源项目，但由于精力有限，英文文档没时间补，有没有什么工具，集成到 github 流水线，自动生成英文文档并 commit?

或者其他工具？

[mhycy]

GPT 写一个

[LengthMin]

GPT 写一个

[dayeye2006199]

请问你有没有中文文档？

[smdbh]

doxygen ，看了就是看了

[Nazz]

我偷懒的做法是只写英文 README

[liantian]

GPT 真可以...

我现在 80%的代码注释都是 gpt 生成的。自己再修缮下。

[Onefork]

@liantian 能给介绍一下具体操作不？

[liantian]

@Onefork
有个叫 ast 的标准库 https://docs.python.org/3/library/ast.html
这个标准库可以 parse 一个 py 文件，然后抽象成一个 tree 对象。
然后用 ast.NodeTransformer 历遍节点，加注释，这之间调用 openai 的 api ，怎么问就靠你的灵性了

最后用一个叫 https://github.com/simonpercivall/astunparse 的库，把这个对象，还原成 py 文件。

当然写代码的时候，函数名稍微正常点。

[liantian]

@Onefork 生成文档当然就是 pydoc 了。

不过 openai 的水平嘛....

虽然我用的 3.5...4.0 没下来，但是省时间确实省，kpi 也确实完成了。

至于质量，躺就完了，等给我填坑的年轻人来吐槽。

[liantian]

@Onefork 对了，有点没审题。如果不是 python ，那么就搜索 refactoring tool 。
思路就是找重构库，把语言文件 parse 抽象成对象，然后插注释，然后 unparse/dumps 。不同的语言不同的工具叫法不一样，思路一样的。

[cnbatch]

GPT + Google Translate

先用 GPT ，扫一眼觉得没问题了就用，想要改改表述方式就换谷歌翻译然后重新丢给 GPT 改一改。

[Onefork]

@liantian 谢谢 这操作很骚啊 能生成有意义的注释吗？

[liantian]

@Onefork
1. GPT 有点"提问的艺术"。然后你可以在这个过程中...学习怎么提问，怎么规划让 gpt 为你干活的过程。
2. GPT-4 的 API 比 GPT-3.5 强，未来 GPT-5 肯定更强...合理的提问方法。4.0+人工 review ，我觉得应付一个开源项目木问题啦。

最后就是....补文档很枯燥无趣，找 gpt 干活，扩展思维+乐趣+成就感，然后根据你的总量，还省了时间。