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

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

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

Answer 1

有各种各样的工具可以执行您所寻求的操作，他们将提取方法/类/属性等签名以及您的xml注释：

See Here

And Here

And this SO question

Visual Studio，记录所有方法和类，而不实现它们

1 个答案: