一、概述
tslint-jsdoc-rules
是一个支持 TypeScript 的规则集合,tslint-jsdoc-rules
中的规则主要是针对 JSDoc 注释的规范,使用这个插件可以更好地帮助代码规范化。在本文中,我们将介绍 tslint-jsdoc-rules
使用教程,包括其安装、配置以及使用方法。
二、安装
使用 npm
命令安装 tslint-jsdoc-rules
:
--- ------- ------------------ ----------
安装完成后,将会在 node_modules
目录中找到 tslint-jsdoc-rules
的安装文件。
三、配置
在 tslint
配置文件中添加 tslint-jsdoc-rules
规则:
- ---------- - -------------------- -- ----------------- - -------------------- -- -------- - ---------------- ----- ---------------- ----- ------------------ ----- ----------------- ---- - -
在上述 tslint
配置文件中,通过 rulesDirectory
的方式指定了使用 tslint-jsdoc-rules
规则集。
四、使用
在代码中增加 JSDoc 注释以符合规则,例如:
--- - --- --- ------- --------- - ------ -------- - - --- ----- ------ - ------ -------- - - --- ------ ------ - -------- -------- --- --- -- - --- - -- -------- ------ ------- -- -------- ------ - ------ - - -- -
在上述代码中,我们增加了 JSDoc 注释,以符合 require-jsdoc
、require-param
和 require-returns
规则。
五、总结
tslint-jsdoc-rules
可以帮助我们更好的规范化代码,使代码更加易读易维护,tslint-jsdoc-rules
的安装和配置都比较简单,对于团队协作也是非常有帮助的。希望本文对大家有所帮助。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5eee9d287a6cc516fbab6e17