Visual Studio 2015查看所有评论

Question

所以，我正在开发VS 2015中的.Net项目，并将其作为其他工作人员的教程/参考表。考虑到这一点，我正在评论作为在代码中传达重要点的主要方法。

我的问题是：有没有办法查看整个项目/解决方案的所有评论？

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;
}

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