簡體   English   中英

Angular2 / TypeScript的編碼標准

[英]Coding standards for Angular2/TypeScript

我想知道是否就如何在TypeScript中編寫可重用的Angular2代碼達成了至少一些社區共識。 我試圖總結我在Angular2上下文中發現的內容和想要了解的內容。

模塊/應用程序目錄結構和文件名

  • 官方教程中,我看到他們將所有代碼放入app目錄,所有依賴項(如node_modules或類型)都位於父目錄中。

  • 小寫的文件名, .component.ts .service.ts后綴,服務的.service.ts 他們將所有文件都放在同一個目錄中,這會造成很大的麻煩嗎?

  • 每個文件一個類/接口/枚舉。 對於類,函數,接口和其他名稱,最好遵循MicrosoftTypeScript編碼指南

模塊

  • 模塊應該使用postinstall npm hook進行編譯和捆綁嗎? 還是像大多數JavaScript庫一樣直接在git上提供捆綁版本更好?
  • 當我期望模塊僅由瀏覽器使用時,我應該默認使用模塊的system類型嗎?還是始終使用UMD更好?
  • 有什么理由使用CommonJSAMD代替system嗎?

使用第三方模塊

  • 我是否應該期望其他開發人員將我的模塊嵌入<script>標簽,或者他們將使用System.import()加載它?
  • 如果我的模塊具有對其他JavaScript庫的依賴關系,那么最好為整個模塊提供具有所有依賴關系的捆綁版本,還是只在package.json定義它們?

Angular2新聞中有《 Angular 2樣式指南》https://github.com/mgechev/angular2-style-guide ):

以下樣式指南的目的是為Angular 2應用程序的開發提供一套最佳實踐和樣式指南。 如果您正在尋找語法,約定俗成的樣式指南...

Angular 1有一個由John Papa撰寫的社區認可的風格指南。 就會出現類似的角2中創建的東西其實你可以在看到代替這個具有英雄例子巡回走到一起開始angular.io

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM