programming-languages - 有没有一个程序可以帮助理解另一个程序？

Question

我需要记录我目前正在开发的软件。该软件由几种编程语言和脚本组成，这让我开始思考。如果新的开发人员出现并需要修复某些东西，他们可能知道 Java，但可能不知道 bash 脚本。如果有一个程序可以帮助理解什么，那就太好了

for f in "$@" ; do

方法。我正在考虑创建一个带有代码和语法突出显示的静态 HTML 页面的东西，如果你将鼠标悬停在某个东西上(比如“for”)，它会显示一个带有解释的弹出窗口:

for starts a loop which iterates over all values that follow in. In the loop, you can access each value via the variable $f. The loop body is between do and done

这样的东西已经存在了吗？

[编辑] 这只是一个例子。您将获得 f 的另一个帮助, in , "$@" , ;和 do ，即应该解释该行的每个元素。未知元素(如命令名称)应链接到 Google。因此，即使您遗漏了一些细节，您也可以理解它的作用。

[EDIT2] 我知道你不能编写一个程序来理解另一个程序的作用。我正在寻找的是一个简单的工具，它将执行“扩展语法突出显示”，因为它将为表达式着色并给出 短解释它的含义(可能还有一些深入引用的链接)。

这适用于知道如何编程但之前可能没有见过一些晦涩构造的人。说

echo "Error" 1>&2

每个 bash 程序员都知道这意味着什么，但 Java 开发人员可能会对 1>&2 感到困惑。尽管他们可以猜到 echo == System.out.println .一个简单的“将标准输出重定向到标准错误”将清除一切并立即发出“啊哈!”这使他们能够保持当前的思路。

Answer 1

可以使用 ANTLR 构建这样的工具，即使用该语言的 ANTLR 语法将代码解析为抽象语法树，并编写生成带注释代码的 HTML 生成器。

对于语言学习或探索您不维护的项目的源代码来说，这听起来像是一个有用的工具——但它是否适合文档？

为什么帮助其他语言的程序员在这个实现细节级别理解代码很重要？任何在这个级别维护实现的人显然都必须了解该语言，并且可能会有一个 IDE 来完成大部分工作。

也就是说，我肯定会考虑将这样的工具作为学习辅助工具。