有没有针对TypeScript源代码生成文档的工具？还是应该使用像NaturalDocs这样的通用工具？块注释/为独立文档准备的注释，推荐使用哪种风格？
我应该使用什么：
///<foo>bar</foo> MSVS kind of comments?
/** @javadoc style comments */
或者也许
/*
Something like this?
*/
我害怕使用///，因为它被用于导入，而我不想踩在可能以类似方式引入的其他未来功能上——但你永远不知道...
还是有可能从TypeScript生成文档化的JavaScript，然后使用JavaScript工具链吗？
我刚刚发布了一个名为TypeDoc的工具，它可以将TypeScript *.ts文件生成html api文档页面。
文档生成器运行TypeScript编译器并从生成的编译器符号中提取类型信息。因此，您不必在注释中包含任何其他元数据。
如果您想尝试，请通过npm安装并运行该工具：
npm install typedoc --global
typedoc --out path/to/documentation/ path/to/typescript/project/
如果您想知道使用TypeDoc创建的文档是什么样子，请前往该项目的GitHub页面：
该回答来自2013年。现在存在其他（维护的）解决方案-其中一些在下面的答案中提到。
原始回答：
也许有点晚了，但我在遇到这个问题后发现还没有工具可以做到这一点。所以我fork了TS编译器并创建了代码来实现它。
在v0.9.0.1处fork TypeScript编译器项目，然后添加了“--documentation”选项，该选项将从您放入代码中的任何JSDoc生成wiki文档（只需纯输出方法/属性等即可不需要）。)
它会生成.ts.wiki文件，文件内容适合直接上传到CodePlex等网站（如果您还使用新的-- wikiRemoveRoot和-- wikiSourceRoot参数，则看下面的fork-我的第一个提交说明），或者您可以调整代码以生成HTML（这相对简单-我已经完成了编译器/ delcrationEmitter的繁重工作 :)）
希望这能帮助到您（或这个问题的未来读者）
Ed
你可以在函数上方使用这种注释。
/**
* Comment goes here
*/
接下来，当您使用该方法时，它将显示相关文档。
生成XML文档注释是TypeScript语言提议的其中一个问题。
目前，TypeScript工具支持JSDoc Announcing TypeScript 0.8.2。
因此，您肯定希望使用JSDoc样式的注释。如果您只需要为智能感知添加注释，则使用JSDoc即可满足您的要求。如果您需要注释，因为您想为API消费者提供文档 - 您应该使用带有注释的声明文件（*.d.ts）。如果您想在Web上生成漂亮的文档 - 我想等待TypeScript团队实现生成XML文档注释（或手动编写）将很容易。
module example {
/**
* My class description
* @class example.MyClass
*/
export class MyClass {
/**
* Description of my property
* @property {String} myProperty
*/
myProperty: string = null;
/**
* This property will be removed in compiled JavaScript, that's why
* this documentation will not be visible in jsduck.
*/
willNotWork: string;
/**
* Description of my method
* @method myFunction
* @param {String} myParam
*/
myFunction(myParam: string): void {
}
}
} // end of module
我编写了一个工具，可以从声明（.d.ts）文件这里生成HTML文档。它支持JSDoc风格的基本注释。
使用-d -c选项编译您的TypeScript源文件以生成声明文件并保留注释。然后安装后，您可以运行
typescript-docs *.d.ts
在标准输出上生成HTML文档。
要将输出保存到文件中，请使用
typescript-docs *.d.ts --output=path/to/output.html