如何为Nunit项目下的所有方法/类创建文档

Question

我目前正在使用带有VS代码的C#进行Selenium Nunit测试。

我们正在关注页面对象模型。

我们只是想列出文档或网页(localhost(中的所有方法和类，就像api文档看起来一样。。

如何做到这一点？

感谢

Answer 1

要明确的是，您正在寻找某种方法来记录组成页面对象模型的所有类/方法？

这与硒或nunit无关。只需使用以下XML文档注释来记录您的C#代码：

/// <summary>
/// This class does something.
/// </summary>
public class SomeClass
{
}

然后使用DocFX或Sandcastle之类的工具为文档生成HTML页面。

来自微软(重点矿(：

XML文档注释是一种特殊类型的注释，添加在任何用户定义类型或成员的定义之上。它们很特别，因为编译器可以对它们进行处理，以便在编译时生成XML文档文件。编译器生成的XML文件可以与您的一起分发。NET程序集，以便Visual Studio和其他IDE可以使用IntelliSense快速显示有关类型或成员的信息。此外，XML文件可以通过DocFX和Sandcastle等工具运行，生成API参考网站。

来源：https://learn.microsoft.com/en-us/dotnet/csharp/codedoc