TypeScript編碼規(guī)則有哪些

命名

1. 使用 PascalCase 方式對(duì)類進(jìn)行命名.

2. 接口命名中不要使用前綴字母 I .

3. 使用 PascalCase 方式對(duì)枚舉值進(jìn)行命名.

4. 使用 camelCase 方式對(duì)函數(shù)進(jìn)行命名.

5. 使用 camelCase 方式對(duì)屬性和本地變量進(jìn)行命名.

6. 私有屬性命名不要使用前綴 _ .

7. 盡可能在命名中使用整個(gè)單詞 .

組件

1. 每個(gè)邏輯組件一個(gè)文件 (例如： parser, scanner, emitter, checker).

2. 不要添加新文件. :)

3. 帶有".generated.*"后綴的文件是自動(dòng)生成的，不要手動(dòng)去修改.

類型

1. 除非您需要跨多個(gè)組件共享，否則不要導(dǎo)出類型/函數(shù).

2. 不要向全局命名空間引入新類型/值.

3. 共享類型應(yīng)在 types.ts 中定義.

4. 在文件中，應(yīng)首先輸入類型定義.

`null` 和 `undefined`

1. 使用 undefined , 不要使用 null .

一般假設(shè)

1. 將節(jié)點(diǎn)，符號(hào)等對(duì)象視為創(chuàng)建它們的組件之外的不可變對(duì)象。 不要改變它們。

2. 創(chuàng)建后，默認(rèn)情況下將數(shù)組視為不可變.

類

1. 為保持一致性，請(qǐng)不要在核心編譯器管道中使用類。 請(qǐng)改用函數(shù)閉包.

標(biāo)志

1. 應(yīng)該將類型上超過(guò)2個(gè)相關(guān)的布爾屬性轉(zhuǎn)換為標(biāo)志。

注釋

1. 對(duì)函數(shù)，接口，枚舉和類使用JSDoc樣式注釋。

字符串

1. 使用雙引號(hào).

2. 用戶可見(jiàn)的所有字符串都需要進(jìn)行本地化（在diagnosticMessages.json中創(chuàng)建一個(gè)條目）。

診斷信息

1. 在句子末尾使用句號(hào).

2. 對(duì)不確定的實(shí)體使用不定的文章.

3. 應(yīng)該命名確定的實(shí)體（這是為變量名，類型名等等。）.

4. 在陳述規(guī)則時(shí)，主題應(yīng)該是單數(shù)的 (e.g. "An external module cannot…" instead of "External modules cannot…").

5. 使用現(xiàn)在時(shí).

診斷消息代碼

診斷分為一般范圍。 如果添加新的診斷消息，請(qǐng)使用大于相應(yīng)范圍中最后使用的數(shù)字的第一個(gè)整數(shù)。

• 1000 句法消息的范圍

• 2000 用于語(yǔ)義消息

• 4000 用于聲明發(fā)出消息

• 5000 用于編譯器選項(xiàng)消息

• 6000 用于命令行編譯器消息

• 7000 對(duì)于noImplicitAny消息

一般構(gòu)造

出于各種原因，我們避免某些結(jié)構(gòu)，并使用我們自己的一些結(jié)構(gòu)。 其中：

1. 不要使用 for..in 語(yǔ)句; 相反，使用 ts.forEach ， ts.forEachKey 和 ts.forEachValue 。 請(qǐng)注意它們的語(yǔ)義略有不同。

2. 當(dāng)它不是非常不方便時(shí)，嘗試使用 ts.forEach ， ts.map 和 ts.filter 而不是循環(huán)。

風(fēng)格

1. 使用箭頭函數(shù)而不是匿名函數(shù)。必要時(shí)僅限制環(huán)繞箭頭功能參數(shù)。例如， （x）=> x + x 錯(cuò)誤，但以下是正確的:

2. x => x + x

3. (x,y) => x + y

4.      <T>(x: T, y: T) => x === y

5. 始終用花括號(hào)環(huán)繞循環(huán)和條件體。 允許在同一行上的語(yǔ)句省略大括號(hào).

6. 開(kāi)放的花括號(hào)總是與任何必要條件都在同一條線上.

7. 帶括號(hào)的構(gòu)造應(yīng)該沒(méi)有周圍的空格。單個(gè)空格在這些構(gòu)造中使用逗號(hào)，冒號(hào)和分號(hào)。 例如：

8. for (var i = 0, n = str.length; i < 10; i++) { }

9. if (x < 10) { }

10. function f(x: number, y: string): void { }

11. 每個(gè)變量語(yǔ)句使用一個(gè)聲明
    (i.e. 使用var x = 1; var y = 2; 而不是 var x = 1, y = 2;).

12. else 與閉合的大括號(hào)分開(kāi).

13. 每個(gè)縮進(jìn)使用4個(gè)空格.