目标:
如果项目中文件@author
内的任何地方使用了标记,则发出警告.js
。
问题:
是jshint
其他静态代码检查工具可以提供帮助的东西吗?如果没有,我有什么选择?
描述:
我完全同意Paul在Javadoc @author标签良好实践线程中的回答,并将@author
标签视为不必要的噪音。
而且,在Python世界中,我见过人们在检查标签的用法。例如,Openstack Style Guidelines
明确声明不使用@author
标签。他们开发了一套自定义flake8
检查,其中包括:
[H105] Don’t use author tags.
现在,我正在尝试解决JavaScript中的相同问题。
示例(不应通过代码质量检查):
/**
* @author John Smith <[email protected]>
*/
'use strict';
不,jshint无法做到这一点。只需在所有来源中进行grep查找@author。如果您愿意,可以将其放在git pre-commit钩子中。或者,如果创建文档时遇到@author,您可以破解JSDoc从而出错。
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句