JavaScript编码标准的可视示例

时间:2013-10-29 16:05:23

标签: javascript coding-style standards

我们的团队正致力于为JavaScript构建编码标准文档。像semi-colon usespaces vs. tabscurly brace usagemultiple var statements等等。我认为包含一个代码块(最后)代表我们视觉上的标准。

字体有时会显示为pangram以显示每个字母的示例。例如:

  

快速的棕色狐狸跳过懒狗

JavaScript有这样的东西吗?

显然,语法组合的数量是非离散的,但是通过一个简短的例子可以证明常见的情况。有没有人遇到像这样的代码块?

更新

要明确的是,我不是在寻找那些充斥着每个概念的孤立示例的标准文档。我们已经有了这样的标准文件。

我正在寻找一个 代码示例,该示例将最常见的标准合并到一个示例中。

1 个答案:

答案 0 :(得分:0)

您可以设置这些规则,并通过JSHintJSBeautifier等工具强制执行这些规则。

使用这些工具,您可以在您选择的SCM中设置一个预提交钩子,它将运行linter / beautifier并解释文件是否与正确的规范不匹配。

然后,您的仓库中的所有内容都将成为如何编码的示例!

如果您使用Grunt之类的内容,那么执行此操作非常简单,因为JSBeautifierJSHint都有任务。

还有无数其他工具也提供此功能。

你可以在

中完成
  • 调用这些程序的CLI工具的BASH脚本
  • JAKE
  • CAKE
  • a MAKEFILE
  • 自定义节点脚本
  • 等等等

如果你纯粹想要记录它,你可以看到你的问题的评论指向几个公司的特定Javascript风格指南,你可以批量使用,或用于生成自己的。虽然我会推动你创建工具来强制执行这些。