这是一个创建于 512 天前的主题，其中的信息可能已经有所发展或是发生改变。
自己做了个开源项目，但由于精力有限，英文文档没时间补，有没有什么工具，集成到 github 流水线，自动生成英文文档并 commit?
或者其他工具？
 |
1
mhycy 2023-06-30 10:14:54 +08:00
GPT 写一个
|
 |
2
LengthMin 2023-06-30 10:16:37 +08:00
GPT 写一个
|
 |
3
dayeye2006199 2023-06-30 11:13:23 +08:00
请问你有没有中文文档？
|
 |
4
smdbh 2023-06-30 11:48:49 +08:00
doxygen ，看了就是看了
|
 |
5
Nazz 2023-06-30 12:22:51 +08:00 via Android  3
我偷懒的做法是只写英文 README
|
 |
6
liantian 2023-06-30 12:29:05 +08:00
GPT 真可以...
我现在 80%的代码注释都是 gpt 生成的。自己再修缮下。 |
|
8
liantian 2023-06-30 17:07:07 +08:00
@Onefork
有个叫 ast 的标准库 https://docs.python.org/3/library/ast.html 这个标准库可以 parse 一个 py 文件，然后抽象成一个 tree 对象。 然后用 ast.NodeTransformer 历遍节点，加注释，这之间调用 openai 的 api ，怎么问就靠你的灵性了 最后用一个叫 https://github.com/simonpercivall/astunparse 的库，把这个对象，还原成 py 文件。 当然写代码的时候，函数名稍微正常点。 |
|
9
liantian 2023-06-30 17:09:58 +08:00
@Onefork 生成文档当然就是 pydoc 了。
不过 openai 的水平嘛.... 虽然我用的 3.5...4.0 没下来，但是省时间确实省，kpi 也确实完成了。 至于质量，躺就完了，等给我填坑的年轻人来吐槽。 |
|
10
liantian 2023-06-30 17:16:04 +08:00
@Onefork 对了，有点没审题。如果不是 python ，那么就搜索 refactoring tool 。
思路就是找重构库，把语言文件 parse 抽象成对象，然后插注释，然后 unparse/dumps 。不同的语言不同的工具叫法不一样，思路一样的。 |
 |
11
cnbatch 2023-06-30 17:22:47 +08:00 via Android
GPT + Google Translate
先用 GPT ，扫一眼觉得没问题了就用，想要改改表述方式就换谷歌翻译然后重新丢给 GPT 改一改。 |
Select Language