c# - Visual Studio，文档所有没有实现的方法和类

Question

我需要移交的项目中的一个要求是我使用的所有类和方法的文档，但没有它们的实现。

我的项目中有 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();
}

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

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

Answer 1

有多种工具可以满足您的需求，它们将提取方法/类/属性等签名以及您的 xml 注释：

看这里

和这里

这个问题