Shulou(Shulou.com)06/01 Report--

This article mainly introduces what the TypeScript coding rules are, have certain reference value, interested friends can refer to, I hope you can learn a lot after reading this article, let the editor take you to understand it.

Naming

Use PascalCase to name the class.

Do not use the prefix letter I.

Use PascalCase to name enumerated values.

Use camelCase to name the function.

Use camelCase to name properties and local variables.

Do not use the prefix _.

Use the whole word in the naming as much as possible.

module

One file for each logical component (for example: parser, scanner, emitter, checker).

Do not add new files. :)

Files with the suffix ".generated. *" are generated automatically. Do not modify them manually.

Types

Do not export types / functions unless you need to share across multiple components.

Do not introduce new types / values into the global namespace.

The sharing type should be defined in types.ts.

In the file, you should first enter the type definition.

`null` and `undefined`

Use undefined, not null.

General hypothesis

Treat nodes, symbols, and other objects as immutable objects other than the components that created them. Don't change them.

Once created, the array is treated as immutable by default.

Class

For consistency, do not use classes in the core compiler pipeline. Please use function closure instead.

Mark

More than 2 related Boolean attributes on the type should be converted to flags.

Annotation

Use JSDoc style annotations for functions, interfaces, enumerations, and classes.

String

Use double quotation marks.

All strings visible to the user need to be localized (create an entry in diagnosticMessages.json).

Diagnostic information

Use a full stop at the end of a sentence.

Use uncertain articles for uncertain entities.

The identified entity should be named (this is the variable name, type name, and so on. )。

When stating a rule, the subject should be singular (e.g. "An external module cannot..." Instead of "External modules cannot...") .

Use the present tense.

Diagnostic message code

The diagnosis is divided into general scope. If you add a new diagnostic message, use the first integer that is greater than the last number used in the appropriate range.

1000 scope of syntactic messages

2000 for semantic messages

4000 is used to declare and send messages

5000 for compiler option messages

6000 for command line compiler messages

7000 for noImplicitAny messages

General structure

For a variety of reasons, we avoid certain structures and use some of our own. Where:

Do not use for..in statements; instead, use ts.forEach, ts.forEachKey, and ts.forEachValue. Note that their semantics are slightly different.

When it's not very inconvenient, try using ts.forEach, ts.map, and ts.filter instead of loops.

style

Use arrow functions instead of anonymous functions. Limit only the orbit arrow function parameters if necessary. For example, (x) = > x + x error, but the following is correct:

X = > x + x

(XBI y) = > x + y

(X: t, y: t) = > x = y

Always surround loops and conditional bodies with curly braces. Allows statements on the same line to omit curly braces.

Open curly braces are always on the same line as any necessary condition.

Parenthesized constructions should have no surrounding spaces. Individual spaces use commas, colons, and semicolons in these constructs. For example:

For (var I = 0, n = str.length; I < 10; iTunes +) {}

If (x < 10) {}

Function f (x: number, y: string): void {}

Each variable statement uses a declaration

(i.e. Use var x = 1; var y = 2; instead of var x = 1, y = 2;.

Else is separated from closed curly braces.

Use 4 spaces for each indent.

Thank you for reading this article carefully. I hope the article "what are the TypeScript coding rules" shared by the editor will be helpful to you. At the same time, I also hope you will support us and pay attention to the industry information channel. More related knowledge is waiting for you to learn!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.