Angular2 / TypeScript的编码标准

时间:2016-02-22 18:17:49

标签: javascript typescript angular

我想知道是否至少有一些社区对如何在TypeScript中编写可重用的Angular2代码达成共识。我试着总结一下我在Angular2的背景下发现的以及我想知道的内容。

模块/应用程序目录结构和文件名

  • Coding guidelines for TypeScript by Microsoft中,我看到他们将所有代码放入org.apache.hadoop.hive.ql.io.CombineHiveInputFormat目录,所有依赖项如hive.input.format或打字都在父目录中。

  • 小写文件名,组件的app后缀和服务的node_modules。他们把所有文件放在同一个目录上,这将是一个巨大的混乱?

  • 每个文件一个类/接口/枚举。对于类,函数,接口和其他名称,最好坚持UMD

模块

  • 模块应该使用.component.ts .service.ts挂钩编译和捆绑自己吗?或者像大多数JavaScript库一样直接在git上提供捆绑版本更好吗?
  • 默认情况下,当我期望我的模块仅供浏览器使用或者总是使用CommonJS时,我是否应该坚持使用postinstall类型的模块?
  • 是否有理由使用AMD或{{3}}代替npm

使用第三方模块

  • 我是否应该期望其他开发人员使用system标记嵌入我的模块,或者他们会使用system加载它?
  • 如果我的模块依赖于其他JavaScript库,最好是为我的整个模块提供所有依赖项的捆绑版本,还是只在<script>中定义它们?

2 个答案:

答案 0 :(得分:4)

有{em> Angular 2风格指南(https://github.com/mgechev/angular2-style-guide),正如Angular2 News中所述:

  

以下样式指南的目的是为Angular 2应用程序的开发提供一组最佳实践和样式指南。如果您正在寻找语法,约定的自以为是的样式指南......

答案 1 :(得分:1)

Angular 1有一个由John Papa编写的社区接受的风格指南。将会为Angular 2创建一些类似的东西,事实上你可以在angular.io

处看到这个与英雄之旅的例子一起出现的开始