Visual Studio 2015 查看所有评论

Question

所以，我正在 VS 2015 中开发一个 .Net 项目，希望它可以作为 tutorial/reference sheet 供其他人使用。考虑到这一点，我将注释作为在代码中传达要点的主要方法。

我的问题是：有没有办法查看整个 project/solution 的所有评论？

Answer 1

您可能正在寻找 Documentation Generation 作为最佳格式。 类 中的方法应该有一个描述性摘要，如果对于您的目的来说完全必要，请引用重要的一行。即

/// <summary>
/// This function multiplies two integers and returns the product.
/// Important lines include "return num1 * num2;"
/// </summary>
/// <param name="num1">The first number</param>
/// <param name="num2">The second number</param>
/// <returns>The product</returns>
public int Multiply(int num1, int num2)
{
    return num1 * num2;
}

然后（按照 link 中的说明）生成解决方案的文档。