相关疑难解决方法(0)

在Java API中,我可以看到包的Javadoc注释.

我如何/在何处放置Javadoc注释来记录包？

我不喜欢在创建一个或多个类时为我生成的默认Javadoc,尤其是@author变量,它是我的Windows框中的当前系统用户名.

我想改变它.这可能吗？

目标:

如果在项目中@author的.js文件内的任何位置使用标记,则发出警告.

题:

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

描述:

我完全同意Paul在Javadoc @author标签上的答案标记良好实践主题并将@author标签视为不必要的噪音.

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

[H105] Don’t use author tags.

现在,我正试图在JavaScript中解决同样的问题.

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

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

'use strict';