我正在编写与数学相关的代码。
项目中有一些复杂的数学公式。
直接写计算代码，理解困难；因此，我想对这个提法发表评论。
我希望评论可以阅读，并且易于理解。
我知道我们可以将配方保存在另一个文档文件中，如乳胶或降价。但这总是导致代码被修改但文档没有更新。那时，文件是无用的，甚至是有害的。
如何在科学计算代码中记录数学公式？
计算科学
C++
C
文件
2021-11-30 05:35:23
1个回答
我更喜欢使用支持 C++ 和LaTeX 注释的doxygen ，包括内联和单独的方程。
这样，您将保持您的评论，包括算法的严格数学公式，非常接近源代码。文档的生成可以包含在整个工作流程中（例如，Makefile 或 CMake 目标，具体取决于您的程序集）。
这不会自动解决过时评论的问题；但是，它允许它们尽可能靠近，因此，在修改源代码时，您的数学公式就在附近（如果您的函数和类被适当地设计为具有合理的长度）。因此，您也更有可能编辑评论。
另外，请查看帖子记录科学软件的好方法是什么？，它对记录科学软件的问题有更高层次的看法。
其它你可能感兴趣的问题