Visual Studio,所有方法和类的文档,没有它们的实现

本文关键字:实现 文档 Studio 有方法 Visual | 更新日期: 2023-09-27 18:15:21

我需要提交的项目要求之一是我使用的所有类和方法的文档,而不包括它们的实现。

我有超过100个方法在我的项目。我想知道我是否可以自动化这个过程。

输入:

class A
{
     /// <summary>
     /// Description for SomeMethod.
     /// </summary>
     /// <param name="k">PARAMETER</param>
     /// <returns>PARAMETER + 1</returns>
     public static int SomeMethod(int k)
     {
          return k + 1;
     }
     /// <summary>
     /// Description for AnotherMethod.
     /// </summary>
     public static void AnotherMethod()
     {
          // Code
     }
}

注意:以上不是我项目中的实际代码。

输出:

class A
{
     public static int SomeMethod(int k);
     public static void AnotherMethod();
}

我完整地记录了项目中的每个方法和类。但是,我需要按照我所提供的输出的方式准备每个类中所有方法的列表。

我正在寻找一种工具来加快整个事情,因为我不打算在接下来的一个小时里坐下来复制和粘贴。

Visual Studio,所有方法和类的文档,没有它们的实现

有各种各样的工具可以做你想做的事情,他们会提取方法/类/属性等签名以及你的xml注释:

看到

这个SO问题