Comments in Typescript 1.0.21

介绍：

TypeScript中的注释：Comment TS工具详解

Comment TS是一款专为TypeScript设计的JSDoc注释模板生成器，旨在为开发者提供高效的注释管理工具。TypeScript语言自带大量的注解，Comment TS能确保这些注解不会在注释中重复，从而避免不必要的冗余和潜在的不一致性。

避免警告：

• 警告TS0：@static注解与TypeScript等效注解重复
• 警告TS0：@private注解与TypeScript等效注解重复
• 警告TS0：@param上的类型注解与其TypeScript类型重复，请删除{...}部分

Comment TS还可以根据需要自动生成额外的TODO注释。

支持的JSDoc标签：

• @description
• @param
• @returns
• @template

命名约定：

• 方法/函数名称应以动词开头
• 使用驼峰命名法

操作命令：

添加注释

• 按下Ctrl Alt C两次
• 或从上下文菜单中选择'Comment code'
• 或在代码行上方插入/**

Comment TS会为光标所在或选中的代码生成注释，示例如下：

/**
* 创建一个documenter实例。
*/
constructor()

/**
* // TODO: 注释dispose
* 释放documenter
*/
dispose() {

/**
* // TODO: 注释getScriptVersion
* 获取脚本版本
* @param fileName
* @returns 脚本版本
*/
getScriptVersion(fileName: string): string {

更新现有注释

如果参数发生变化，您可能希望保留未更改参数的注释。

• 选择要更新的注释块，然后
• 按下Ctrl Alt C两次
• 或从上下文菜单中选择'Comment code'
• 或在代码行上方插入/**

设置选项：

• "comment-ts.todoComments"：如果为true，将在注释中添加// TODO:行。如果您使用todo tree等扩展，您将在资源管理器视图中找到所有注释TODO。
• "comment-ts.replaceComments"：选中的JSDoc注释将被更新。如果添加/删除参数，剩余参数的注释不会丢失。
• "comment-ts.includeDescriptionTag"：在您的注释前添加@description。
• "comment-ts.includeAuthorTag"：在您的注释中添加@author标签。
• "comment-ts.authorName"：@author标签后的文本。
• "comment-ts.parseNames"：解析名称以生成注释。例如，GetAccessor将生成"Gets "，SetAccessor将生成"Sets "，方法驼峰命名法名称将被拆分，动词会加s，除非在特殊情况下，...

文档生成器：

• Compodoc：在几秒钟内生成您的Angular项目文档。
• TypeDoc：TypeScript项目的文档生成器。

生成带解构参数的构造函数：

• 用于不可变模型类的有用重构模式：生成所有只读字段的构造函数。
• 您可以使用对象或使用解构模式从例如dto中使用命名参数来初始化模型。

const model = new Model( { result: 42, author: 'adams',.... } );

生成接口：

• 生成所有只读字段的接口。
• 您可以在类的构造函数中使用此接口，以排除不应初始化的属性。

constructor X( dto: IX );

生成私有字段的getter和setter：

• 生成以下划线开头的私有字段的getter和setter属性。

部分源代码从Document This和Typescript Toolbox复制并改编。感谢贡献者！