理解大型科学代码库(图表,注释,注释等)

时间:2014-12-04 14:49:23

标签: annotations doxygen

我经常遇到一个项目,我必须详细了解其他人编写的大型代码库。人们发现哪些工具对于理解大型代码库有用?我专门寻找有助于提供全局和更高层次理解的工具。例如,我开始使用Doxygen创建图表和文档,即使项目代码库本身在评论中没有使用Doxygen也是如此。是否有其他工具可以根据代码本身自动创建图表或文档?人们认为有用的是什么?

为了更进一步,我经常研究涉及科学计算(许多方程式)的代码库。我经常做的就是打印出更加数学化的代码的纸质副本,并将代码翻译成典型的数学符号。是否有人用于创建与代码分开的标记的工具(注释,注释,最好是自由形式的写作或乳胶理解)?我使用Mendeley来记录期刊文章,并且认为对代码做同样的事情是可以的,但我真的希望能够用数学符号看这些方程式。我见过人们使用Knuth的WEB,它将Latex文档与代码结合在一起,但对我来说,它似乎模糊而不是帮助代码维护/开发。

0 个答案:

没有答案