V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
cesign
V2EX  ›  程序员

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

  •  
  •   cesign · 237 天前 · 1826 次点击
    这是一个创建于 237 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

    或者其他工具?

    13 条回复    2023-06-30 21:40:19 +08:00
    mhycy
        1
    mhycy  
       237 天前
    GPT 写一个
    LengthMin
        2
    LengthMin  
       237 天前
    GPT 写一个
    dayeye2006199
        3
    dayeye2006199  
       237 天前
    请问你有没有中文文档?
    smdbh
        4
    smdbh  
       237 天前
    doxygen ,看了就是看了
    Nazz
        5
    Nazz  
       237 天前 via Android   ❤️ 3
    我偷懒的做法是只写英文 README
    liantian
        6
    liantian  
       237 天前
    GPT 真可以...

    我现在 80%的代码注释都是 gpt 生成的。自己再修缮下。
    Onefork
        7
    Onefork  
       237 天前 via Android
    @liantian 能给介绍一下具体操作不?
    liantian
        8
    liantian  
       236 天前
    @Onefork
    有个叫 ast 的标准库 https://docs.python.org/3/library/ast.html
    这个标准库可以 parse 一个 py 文件,然后抽象成一个 tree 对象。
    然后用 ast.NodeTransformer 历遍节点,加注释,这之间调用 openai 的 api ,怎么问就靠你的灵性了

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

    当然写代码的时候,函数名稍微正常点。
    liantian
        9
    liantian  
       236 天前
    @Onefork 生成文档当然就是 pydoc 了。

    不过 openai 的水平嘛....

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

    至于质量,躺就完了,等给我填坑的年轻人来吐槽。
    liantian
        10
    liantian  
       236 天前
    @Onefork 对了,有点没审题。如果不是 python ,那么就搜索 refactoring tool 。
    思路就是找重构库,把语言文件 parse 抽象成对象,然后插注释,然后 unparse/dumps 。不同的语言不同的工具叫法不一样,思路一样的。
    cnbatch
        11
    cnbatch  
       236 天前 via Android
    GPT + Google Translate

    先用 GPT ,扫一眼觉得没问题了就用,想要改改表述方式就换谷歌翻译然后重新丢给 GPT 改一改。
    Onefork
        12
    Onefork  
       236 天前 via Android
    @liantian 谢谢 这操作很骚啊 能生成有意义的注释吗?
    liantian
        13
    liantian  
       236 天前
    @Onefork
    1. GPT 有点"提问的艺术"。然后你可以在这个过程中...学习怎么提问,怎么规划让 gpt 为你干活的过程。
    2. GPT-4 的 API 比 GPT-3.5 强,未来 GPT-5 肯定更强...合理的提问方法。4.0+人工 review ,我觉得应付一个开源项目木问题啦。

    最后就是....补文档很枯燥无趣,找 gpt 干活,扩展思维+乐趣+成就感,然后根据你的总量,还省了时间。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   5715 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 37ms · UTC 08:44 · PVG 16:44 · LAX 00:44 · JFK 03:44
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.