GitHub的JavaScript代码规范

这是Github内部使用的一些 Javascript 代码格式化指南,大家可以参考并建议在自己团队使用。

代码风格

CoffeeScript

  • 用CoffeeScript来写新的js
  • 使用两个空格缩进的tab键
  • 始终使用驼峰命名,不要使用下划线
  • 如果可能的话,使用隐式括号
  • 跟随  @jashkenas 的风格,你可以在文档中找到很好的示例
  • 任何顶层对象都应该在GitHub的命名空间下
  • 永远不要使用 $.get 或 $.post,而是是用 $.ajax 并要同时提供成功和错误的处理程序
  • 使用 $.fn.on 替换 $.fn.bind , $.fn.delegate 和 $.fn.live

原生的JavaScript

  •  避免添加新的js文件
  • 使用两个空格缩进的tab键
  • 最好永远不要使用分号,这意味着你需要避免换行,避免多语句行。了解更多信息,参考 Mislav 的博客文章 (译注:这点实在不太赞同)

文档

尽你的能力去使用TomDoc,既然我们已经做了很多这样的,我认为严格保持它是有道理的 (并记录每一个方法和属性)

选择器

尝试给所有js用到的选择器加上 js- 前缀。这个来自 slightly obtrusive javascript ,这个想法是,你应该能从一个类的名字而知道它的功能。代码库中的大部分代码并没有这么做,让我们试着靠近它。

更详细介绍,请参考这里:https://github.com/styleguide/javascript

 

1 1 收藏

资源整理者简介:一兮

简介还没来得及写 :) 个人主页 · 贡献了5个资源


直接登录

推荐关注

按分类快速查找

关于资源导航
  • 伯乐在线资源导航收录优秀的工具资源。内容覆盖开发、设计、产品和管理等IT互联网行业相关的领域。目前已经收录 1440 项工具资源。
    推送伯乐头条热点内容微信号:jobbole 分享干货的技术类微信号:iProgrammer