javascript - 将 @author 的使用视为代码风格违规

Question

目标:

如果在项目的 .js 文件中的任何地方使用了 @author 标签，则发出警告。

问题:

jshint 或其他静态代码检查工具可以提供帮助吗？如果没有，我有什么选择？

描述:

我完全同意 Paul 在 Javadoc @author tag good practices 上的回答线程并将 @author 标记视为不必要的噪音。

而且，在 Python 世界中，我看到人们检查标签的使用情况。例如，Openstack Style Guidelines明确声明不使用 @author 标签。他们开发了一套自定义 flake8 检查，其中包括:

[H105] Don’t use author tags.

现在，我正在尝试用 JavaScript 解决同样的问题。

示例(这不应通过代码质量检查):

/**
 * @author John Smith <john@smith.com>
 */

'use strict';

Answer 1

不，jshint 不能那样做。只需在寻找@author 的来源中执行 grep。如果你愿意，你可以把它放在一个 git 预提交 Hook 中。或者，如果遇到 @author，您可以破解 JSDoc 以在创建文档时出错。