esign-comment-ts 0.0.1

新介绍内容

Comment TS：TypeScript文件的JSDoc注释模板生成器

Comment TS是一款专为TypeScript文件设计的JSDoc注释模板生成器，旨在提高开发者在编写和管理代码注释时的效率。该工具特别关注避免与TypeScript语言注解重复的警告，如@static、@private和@param类型的冗余注解，确保注释的简洁和一致性。

主要功能：

• 避免冗余警告： Comment TS能够自动检测并避免生成与TypeScript语言注解重复的JSDoc注释，从而减少代码中的不一致性。
• 支持JSDoc标签： 支持常用的JSDoc标签，包括@description、@param、@returns和@template，确保注释的完整性和规范性。
• TODO备注生成： 可选地自动生成TODO备注，方便开发者跟踪未完成的任务。
• 快捷操作： 通过快捷键Ctrl Alt C或上下文菜单中的'Comment code'选项，或者直接在代码行上方插入/**，即可生成或更新注释。
• 自定义设置： 用户可通过设置选项来定制注释生成行为，如是否添加TODO备注，是否更新现有注释，是否包含@description和@author标签等。

使用示例：

生成注释：

/**
* Creates an instance of documenter.
*/
constructor()

/**
* // TODO: comment dispose
* Disposes documenter
*/
dispose() {

/**
* // TODO: comment getScriptVersion
* Gets script version
* @param fileName
* @returns script version
*/
getScriptVersion(fileName: string): string {

更新现有注释：

如果参数发生变化，Comment TS可以保留未更改参数的注释，确保注释的连续性和准确性。

其他功能：

• 文档生成器支持： 与Compodoc和TypeDoc等文档生成器兼容，帮助开发者快速生成项目文档。
• 构造函数和接口生成： 支持生成带有解构参数的构造函数和基于readonly字段的接口，简化模型类和数据传输对象（DTO）的创建。
• 私有字段的getter和setter生成： 自动生成私有字段（以 underscore 开头）的getter和setter属性。

Comment TS借鉴并改进了Document This和TypeScript Toolbox中的部分源码，感谢这些项目的贡献者。

无论您是需要快速生成注释、管理TODO任务，还是生成文档和模型类，Comment TS都是您在TypeScript开发中的得力助手。