记录TypeScript代码的工具和指南？
有没有为TypeScript源代码生成文档的工具？或者我应该使用像NaturalDocs这样的泛型？块注释/用于独立文档卷的注释的推荐样式是什么？
我应该使用：
///<foo>bar</foo> MSVS kind of comments?或
/** @javadoc style comments */或者也许
/*
Something like this?
*/我不敢使用///，因为它是用于导入的，而且我不想在未来以类似的方式引入其他功能--但你永远不会知道……
或者，是否可以从TypeScript生成文档化的JavaScript，然后使用JavaScript工具链？
回答 5
Stack Overflow用户
发布于 2014-06-03 04:15:56
我刚刚发布了一个名为TypeDoc的工具，它可以从TypeScript *.ts文件生成html api文档页面。
文档生成器运行TypeScript编译器，并从生成的编译器符号中提取类型信息。因此，您不必在注释中包含任何其他元数据。
如果您想尝试一下，只需通过npm安装并运行该工具：
npm install typedoc --global
typedoc --out path/to/documentation/ path/to/typescript/project/如果您想了解使用TypeDoc创建的文档是什么样子，请转到项目的GitHub页面：
http://typedoc.org/ | https://github.com/TypeStrong/typedoc
Stack Overflow用户
发布于 2014-09-10 01:52:48
你可以在你的函数上使用这种注释。
/**
* Comment goes here
*/下一步，当你点击你的方法时，它将与文档一起出现。
Stack Overflow用户
发布于 2013-04-29 00:57:22
Generate XML Doc comments是TypeScript语言提出的问题之一。
目前，TypeScript工具支持JSDoc Announcing TypeScript 0.8.2。
因此，您肯定希望对注释使用JSDoc样式。如果你只需要IntelliSense的注释--使用JSDoc就可以满足你的需求。如果您需要注释，因为您想为您的API使用者提供文档-您应该使用带有注释的声明文件(*.d.ts)。如果你想在网络上生成更好的文档，我想等待TypeScript团队实现XML文档注释的生成(或者手动编写)是很容易的。
https://stackoverflow.com/questions/16263480
复制相似问题
腾讯云开发者
