【问题标题】:Documentation lint to Javascript [closed]Javascript的文档lint [关闭]
【发布时间】:2019-07-10 15:02:47
【问题描述】:

我有一个 lint,用于将文档强制归类为 dart 语言中的类、函数或成员类

链接到文档 lint:https://dart-lang.github.io/linter/lints/public_member_api_docs.html

不知道有没有类似 Javascript 的 linter 或工具?

【问题讨论】:

  • @Liam 我不要求替代方案或建议..我想要 1 选项以 dart 语言中的现有功能。

标签: javascript typescript static-analysis lint


【解决方案1】:

JSLint 用于 javascript 或 TSLint 用于 typescript 可以强制使用 JSDoc 样式文档。

或者在 ESLint 中,文档规则名称为“require-jsdoc” https://eslint.org/docs/rules/require-jsdoc

和“valid-jsdoc”https://eslint.org/docs/rules/valid-jsdoc

但这些规则在 ESLint v3.0 中已被弃用 所以 ESLint 团队推荐的替代方案是https://github.com/gajus/eslint-plugin-jsdoc

【讨论】:

  • 您能否详细说明如何启用 JSDoc 强制执行?
  • @Bergi 我更新了所需规则的答案您可以在此路径 .git/hooks/pre-push 中将静态分析添加到您的 git push 命令中
  • 呃,jslint和eslint不一样?
  • @Bergi 哎呀,我用错误的工具名称更新了答案,es 是 ECMAScript,它是 js。
猜你喜欢
  • 1970-01-01
  • 2013-02-22
  • 1970-01-01
  • 1970-01-01
  • 2010-10-19
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多