如何在我的代码中记录数学计算

Question

我正在记录一个进行大量数学计算的大型应用程序。计算本身很简单，但是很多。我的问题：有没有办法有效地记录这些计算？下面是一个例子（注意：这样的操作有几百行）：

double printJobTime = (zHeight / (surfaceDensity / 1000)) * buildTime;

Answer 1

我建议使用XML评论如下：

/// <summary>
/// [Explaine the method function...]
/// </summary>
/// <param name="..."></param>
/// <param name="..."></param>
/// <returns>[Explaine the result...]</returns>
public ... [YourMethod]()
{
    ...
}

看看下面的link:

How to: Insert XML comments for documentation generation

通过启用 XML 文档文件：（在项目属性中）

XML文档文件将在构建项目时自动生成。

如何在我的代码中记录数学计算

How do I document mathematical computations inside my code

c#

documentation