最近感觉,在 LLM 时代,“代码即文档”这个理念已经几乎完全成真了,这一理念普遍被认为源自于极限编程(XP)运动,即优秀的代码应该能够自我说明,清晰地表达其意图和功能,减少额外的文档负担。
而在当前的时代下 LLM 已经可以很好的根据上下文来理解代码的意图和功能了,即使代码并不足够详细和精确,也能通过 LLM 的辅助来快捷使用部分文档不全的开源项目,这样想想很多个人的小项目甚至都不需要有文档了,开发者也可以将精力集中在软件的开发上,可以摆脱写文档这些琐事了。
现在也有 https://deepwiki.com/ 和 https://zread.ai/ 这样的项目可以帮助开源作者快速从源码生成一个项目的文档,不过目前这些服务还不太靠谱,在项目使用较新的库 / 写法的时候 LLM 还是可能产生幻觉。克隆源码提问还是一个更靠谱的 LLM 用法。
不过在当下使用旗舰模型还是有成本的,因此“代码即文档”这个理念还没有完全成真。不过我相信随着 LLM 能力的提升和成本的下降,“代码即文档“ 这个理念很快就会成真,也许以后都不需要文档了(?)