TypeScript注释的语法记录在哪里？

Question

TypeScript注释的语法是否记录在何处？

不管怎样,它现在是否支持C#///系统？

Answer 1

TypeScript使用JSDoc.例如

/** This is a description of the foo function. */
function foo() {
}

要学习jsdoc:http://usejsdoc.org/

但是您不需要在JSDoc中使用类型注释扩展.

Answer 2

您还可以使用以下命令添加有关参数,返回等的信息:

/**
* This is the foo function
* @param bar This is the bar parameter
* @returns returns a string version of bar
*/
function foo(bar: number): string {
    return bar.toString()
}

这将导致像VS Code这样的编辑器将其显示如下:

Answer 3

正确的语法现在是TSDoc使用的语法.它允许您通过Visual Studio Code或其他文档工具了解您的注释.

语法的很好的概述,请点击这里和这里特别.应该"很快"写出准确的规范.

另一个值得检查的文件就是这个文件,你会看到有用的标准标签.

注意:您不应该使用JSDoc,如TSDoc主页上所述:为什么JSDoc不能成为标准？不幸的是,JSDoc语法没有严格规定,而是从特定实现的行为推断出来.大多数标准JSDoc标记都专注于为纯JavaScript提供类型注释,这对于强类型语言(如TypeScript)而言是无关紧要的.TSDoc解决了这些限制,同时也解决了一系列更复杂的目标.

Answer 4

您可以使用常规JavaScript中的注释:

TypeScript语法是Ecmascript 5(ES5)语法的超集.[...]

本文档描述了TypeScript添加的语法语法

除此之外,我只发现了关于语言规范中的评论:

TypeScript还为JavaScript程序员提供了一个可选类型注释系统.这些类型注释类似于Closure系统中的JSDoc注释,但在TypeScript中,它们直接集成到语言语法中.这种集成使代码更具可读性,并降低了将类型注释与其相应变量同步的维护成本.

11.1.1源文件依赖关系:

表单的注释/// <reference path="..."/>添加了对path参数中指定的源文件的依赖性.相对于包含源文件的目录解析路径

资料来源:https:
//github.com/Microsoft/TypeScript/blob/master/doc/spec.md