Question

我需要为测试编写文档注释，然后在HTML文件中生成文档。我使用typedoc成功生成了文档，但仅针对我的类和方法，而不针对我的测试。我的问题是：如何为测试编写文档注释？

为了测试，我使用testcafe。我一直成功地生成了报告。

/ ** *测试许可证02 * / <-未生成此块注释

test（'LICENSE-02'，异步t => {

...

}）;

我需要为测试生成文档注释，但目前仅记录了方法和类。

感谢您的帮助！

Answer 1

我可以在TypeDoc存储库中看到一个类似的问题：https://github.com/TypeStrong/typedoc/issues/821。 TypeDoc仅为TypeScript声明创建文档，例如用于名称空间，类，方法，属性，函数，变量，常量。 TestCafe的测试不是声明，它们只是[pytest] filterwarnings = ignore:.*invalid escape sequence.*:DeprecationWarning:toml.decoder:47函数调用，因此上面的文档注释将被忽略。

您可以将测试主体声明为函数，并对其应用文档注释，例如：

test

我该如何编写文档注释进行测试并使用typedoc进行报告？

1 个答案: