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

Question

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

for f in "$@" ; do

手段.我正在考虑创建一个静态HTML页面的代码加上语法高亮显示的内容,如果你将鼠标悬停在某些内容上(例如"for"),它会显示一个带有解释的弹出窗口:

for启动一个循环,迭代后面的所有值in.在循环中,您可以通过变量访问每个值$f.循环体位于do和之间done

这样的事情已经存在吗？

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

[编辑2]我知道你不能写一个能理解其他程序功能的程序.我正在寻找的是一个简单的工具,它将执行"扩展语法突出显示",因为它将为表达式着色并简要说明它的含义(加上可能是一些深入参考的链接).

这适用于知道如何编程但可能以前没有看过一些模糊构造的人.说

echo "Error" 1>&2

每个bash程序员都知道这意味着什么,但Java开发人员可能会1>&2因为他们可以猜到echo== 而感到困惑System.out.println.一个简单的"重定向stdout到stderr"将清除事情并立即给出"AHA!" 这使他们能够保持目前的思路.

Answer 1

如果你想一想，有一个解释语法的工具并没有那么有用。开发人员可以只用谷歌搜索关键字，而不用像http://www.codeweblog.com/source/那样浏览网站。

我相信良好的注释会更加有用，而且还有一些工具可以使用注释来提取文档（例如，HappyDoc 对 Python 就是这样做的）。