在运行时获取类/函数评论

问题描述 投票:2回答:1

我正在寻找一种方式来获得类和函数的评论在运行时的角度应用在目的上生成自定义文档。使用外部工具生成的文件不符合我的要求。我真的需要通过自己生成的文档。

我做了一些试验和,现在,我有两种可能的情况:

  1. 载入关注类作为一个字符串,并提取与字符串处理意见(而不是在我看来,最好的情况下)。
  2. 导入类和使用TS提取意见。在这一点上,我遇到了一些错误,在我的角度应用当我尝试导入TS:import * as ts from 'typescript'。它显然会导致循环引用。这段代码演示了如何从一个类中提取的意见,但似乎不能在运行时的角度应用程序中使用:comment factory from TypeDoc sources

是否有人有办法从类引用或表示类的字符串抽取注释的想法?

angular typescript reflection comments documentation
1个回答
2
投票

你所要求的是元编程的打字稿,这是不是可在瞬间实现。你需要了解的是,浏览器不直接运行TS码。取而代之的是,代码被编译为JavaScript,才把它运行时发生。和评论那里只是为程序员看 - 它并不需要转移到所产生的JS代码transpiled。

Typedoc只能在编译的时候,所以它可以访问所有的TS源文件。如果你想创建自己的文件解析工具,这很好,但你将需要学习很多关于编程语言解析是如何工作的。搜索“龙书”,“Let's build a simple interpreter”,和其他来源。

© www.soinside.com 2019 - 2024. All rights reserved.