将@author的使用视为违反代码样式

ec

目标:

如果项目中文件@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] 删除。

编辑于
0

我来说两句

0条评论
登录后参与评论

相关文章

来自分类Dev

使用Gradle将代码样式导入Eclipse

来自分类Dev

使用Gradle将代码样式导入Eclipse

来自分类Dev

如何配置Emacs以突出显示违反详细代码样式的C ++?

来自分类Dev

如何配置Emacs以突出显示违反详细代码样式的C ++?

来自分类Dev

使用AnyObject时将Bool视为int

来自分类Dev

如何防止xcode将<##>视为代码段占位符

来自分类Dev

如何使NetBeans将.cpp文件视为C ++源代码?

来自分类Dev

可以将代码审核视为静态分析吗?

来自分类Dev

使用Entity Framework的C#中的代码契约不变违反

来自分类Dev

违反代码优先的主键

来自分类Dev

如何使用jquery ajax将css样式添加到动态加载的代码段

来自分类Dev

在Java流使用.peek()被视为将仅用于调试目的,将记录被视为调试?

来自分类Dev

如果我将C代码视为C ++代码,它将正常运行吗?

来自分类Dev

注释是代码的python行,使用哪种样式?

来自分类Dev

如何使用按钮更改JavaScript代码的样式?

来自分类Dev

使用隐式将类型参数视为数字

来自分类Dev

使用if语句时将字符串视为数字

来自分类Dev

是否可以使用lxml将文本视为xml元素?

来自分类Dev

使用Webpack,是否可以强制将警告视为错误?

来自分类Dev

如何使用熊猫将某些行视为新列

来自分类Dev

使用:normal命令时,vim将注册视为注释

来自分类Dev

使用连接表将记录值透视为列名

来自分类Dev

使用 Pandas 将列值透视为列名

来自分类Dev

使用 PHP 将字符串视为多维数组

来自分类Dev

使用 SQL Server 将选定的列透视为行

来自分类Dev

将Jquery UI自动完成功能与所选的Jquery结合使用,以获得我的代码的Stackoverflow样式?

来自分类Dev

为什么将演员“询问”模式视为反模式或“代码气味”?

来自分类Dev

为什么我的VBA代码将逗号视为换行符?

来自分类Dev

为什么将代码视为Lisp中的数据有用

Related 相关文章

  1. 1

    使用Gradle将代码样式导入Eclipse

  2. 2

    使用Gradle将代码样式导入Eclipse

  3. 3

    如何配置Emacs以突出显示违反详细代码样式的C ++?

  4. 4

    如何配置Emacs以突出显示违反详细代码样式的C ++?

  5. 5

    使用AnyObject时将Bool视为int

  6. 6

    如何防止xcode将<##>视为代码段占位符

  7. 7

    如何使NetBeans将.cpp文件视为C ++源代码?

  8. 8

    可以将代码审核视为静态分析吗?

  9. 9

    使用Entity Framework的C#中的代码契约不变违反

  10. 10

    违反代码优先的主键

  11. 11

    如何使用jquery ajax将css样式添加到动态加载的代码段

  12. 12

    在Java流使用.peek()被视为将仅用于调试目的,将记录被视为调试?

  13. 13

    如果我将C代码视为C ++代码,它将正常运行吗?

  14. 14

    注释是代码的python行,使用哪种样式?

  15. 15

    如何使用按钮更改JavaScript代码的样式?

  16. 16

    使用隐式将类型参数视为数字

  17. 17

    使用if语句时将字符串视为数字

  18. 18

    是否可以使用lxml将文本视为xml元素?

  19. 19

    使用Webpack,是否可以强制将警告视为错误?

  20. 20

    如何使用熊猫将某些行视为新列

  21. 21

    使用:normal命令时,vim将注册视为注释

  22. 22

    使用连接表将记录值透视为列名

  23. 23

    使用 Pandas 将列值透视为列名

  24. 24

    使用 PHP 将字符串视为多维数组

  25. 25

    使用 SQL Server 将选定的列透视为行

  26. 26

    将Jquery UI自动完成功能与所选的Jquery结合使用,以获得我的代码的Stackoverflow样式?

  27. 27

    为什么将演员“询问”模式视为反模式或“代码气味”?

  28. 28

    为什么我的VBA代码将逗号视为换行符?

  29. 29

    为什么将代码视为Lisp中的数据有用

热门标签

归档