This document serves as the complete definition of Google’s coding standards for source code in the JavaScript programming language. A JavaScript source file is described as being in Google Style if and only if it adheres to the rules herein
Like other programming style guides, the issues covered span not only aesthetic issues of formatting, but other types of conventions or coding standards as well. However, this document focuses primarily on the hard-and-fast rules that we follow universally, and avoids giving advice that isn't clearly enforceable [whether by human or tool]
1. 1 Terminology notes
In this document, unless otherwise clarified
The term comment always refers to implementation comments. We do not use the phrase documentation comments, instead using the common term “JSDoc” for both human-readable text and machine-readable annotations within
48/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
This Style Guide uses RFC 2119 terminology when using the phrases must, must not, should, should not, and may. The terms prefer and avoid correspond to should and should not, respectively. Imperative and declarative statements are prescriptive and correspond to must
Other terminology notes will appear occasionally throughout the document
1. 2 Guide notes
Example code in this document is non-normative. That is, while the examples are in Google Style, they may not illustrate the only stylish way to represent the code. Optional formatting choices made in examples must not be enforced as rules
2 Source file basics
2. 1 File name
File names must be all lowercase and may include underscores [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
49] or dashes [/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
50], but no additional punctuation. Follow the convention that your project uses. Filenames’ extension must be /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
512. 2 File encoding. UTF-8
Source files are encoded in UTF-8
2. 3 Special characters
2. 3. 1 Whitespace characters
Aside from the line terminator sequence, the ASCII horizontal space character [0x20] is the only whitespace character that appears anywhere in a source file. This implies that
All other whitespace characters in string literals are escaped, and
Tab characters are not used for indentation
2. 3. 2 Special escape sequences
For any character that has a special escape sequence [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
52, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
53, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
54, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
55, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
56, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
57, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
58, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
59, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
60], that sequence is used rather than the corresponding numeric escape [e. g /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
61, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
62, or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
63]. Legacy octal escapes are never used2. 3. 3 Non-ASCII characters
For the remaining non-ASCII characters, either the actual Unicode character [e. g.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
64] or the equivalent hex or Unicode escape [e. g. /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
65] is used, depending only on which makes the code easier to read and understandTip. In the Unicode escape case, and occasionally even when actual Unicode characters are used, an explanatory comment can be very helpful
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
8/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
Mẹo. Đừng bao giờ làm cho mã của bạn khó đọc hơn chỉ vì sợ rằng một số chương trình có thể không xử lý đúng các ký tự không phải ASCII. If that happens, those programs are broken and they must be fixed
3 Source file structure
All new source files should either be a
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 file [a file containing a /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 call] or an ECMAScript [ES] module [uses /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
68 and /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
69 statements]. Files consist of the following, in order- License or copyright information, if present
70 JSDoc, if present/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
66 statement, if a/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
66 file/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- ES
68 statements, if an ES module/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
74 and/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
75 statements/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Việc triển khai tệp
Chính xác một dòng trống phân tách từng phần hiện có, ngoại trừ phần triển khai của tệp, có thể có 1 hoặc 2 dòng trống trước
3. 1 Giấy phép hoặc thông tin bản quyền, nếu có
Nếu thông tin giấy phép hoặc bản quyền thuộc về một tệp, thì nó thuộc về đây
3. 2 /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
70 JSDoc, nếu có
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
Nhìn thấy ??
3. 3 /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 statement
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
Tất cả các tệp
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 phải khai báo chính xác một tên /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 trên một dòng. các dòng chứa khai báo /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 không được ngắt dòng và do đó là ngoại lệ đối với giới hạn 80 cộtToàn bộ đối số với google. mô-đun là những gì xác định một không gian tên. Đó là tên gói [một mã định danh phản ánh đoạn cấu trúc thư mục chứa mã] cộng với, tùy chọn, lớp/enum/giao diện chính mà nó xác định được nối vào cuối
Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
53. 3. 1 thứ bậc
Không gian tên mô-đun không bao giờ được đặt tên là con trực tiếp của không gian tên mô-đun khác
không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
6Hệ thống phân cấp thư mục phản ánh hệ thống phân cấp không gian tên, sao cho các thư mục con được lồng sâu hơn là các thư mục con của các thư mục mẹ cấp cao hơn. Lưu ý rằng điều này ngụ ý rằng chủ sở hữu của các nhóm không gian tên "cha mẹ" nhất thiết phải biết tất cả các không gian tên con, vì chúng tồn tại trong cùng một thư mục
3. 3. 2 /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
81
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
Câu lệnh đơn
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 có thể tùy chọn được theo sau bởi lệnh gọi tới /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
83. Tránh /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
84 khi có thểThí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
1/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
81 tồn tại để dễ dàng chuyển đổi từ các không gian tên dựa trên phân cấp đối tượng truyền thống nhưng đi kèm với một số hạn chế đặt tên. Vì tên mô-đun con phải được tạo sau không gian tên cha, nên tên này không được là con hoặc cha của bất kỳ /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 nào khác [ví dụ: /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
87 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
88 không thể tồn tại an toàn, cũng như /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
87 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
90]3. 3. 3 /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 Xuất khẩu
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
Các lớp, enum, hàm, hằng số và các ký hiệu khác được xuất bằng đối tượng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
92. Các biểu tượng đã xuất có thể được xác định trực tiếp trên đối tượng /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
92 hoặc được khai báo cục bộ và xuất riêng. Các biểu tượng chỉ được xuất nếu chúng được sử dụng bên ngoài mô-đun. Các ký hiệu cục bộ mô-đun không được xuất khẩu không được khai báo /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
94 cũng như tên của chúng không kết thúc bằng dấu gạch dưới. Không có thứ tự theo quy định cho các ký hiệu được xuất và mô-đun-cục bộví dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
2____53Không chú thích đối tượng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
92 là /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
96 vì nó đã được trình biên dịch coi là hằng số/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
63. 4 mô-đun ES
3. 4. 1 Nhập khẩu
Báo cáo nhập khẩu không được ngắt dòng và do đó là một ngoại lệ đối với giới hạn 80 cột
3. 4. 1. 1 Đường dẫn nhậpCác tệp mô-đun ES phải sử dụng câu lệnh
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
68 để nhập các tệp mô-đun ES khác. Đừng /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 mô-đun ES khác/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
93. 4. 1. 1. 1 Phần mở rộng tệp trong đường dẫn nhậpPhần mở rộng tệp
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
51 không phải là tùy chọn trong đường dẫn nhập và phải luôn được đưa vào/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
1/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
0Không nhập cùng một tệp nhiều lần. Điều này có thể gây khó khăn cho việc xác định số lần nhập tổng hợp của một tệp
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
13. 4. 1. 3 Đặt tên nhập khẩu3. 4. 1. 3. 1 Nhập mô-đun đặt tênTên nhập mô-đun [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
500] là tên /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
501 được lấy từ tên tệp đã nhập/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
2/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
33. 4. 1. 3. 2 Đặt tên nhập khẩu mặc địnhTên nhập mặc định được bắt nguồn từ tên tệp đã nhập và tuân theo các quy tắc trong ??
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
4Ghi chú. Nói chung, điều này sẽ không xảy ra vì xuất mặc định bị cấm theo hướng dẫn kiểu này, hãy xem ??. Nhập mặc định chỉ được sử dụng để nhập các mô-đun không tuân theo hướng dẫn kiểu này
3. 4. 1. 3. 3 Đặt tên cho hàng nhập đã đặt tênNói chung, các ký hiệu được nhập thông qua quá trình nhập có tên [______3502] nên giữ nguyên tên. Tránh nhập bí danh [______3503]. Thích sửa các xung đột tên bằng cách sử dụng nhập mô-đun [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
504] hoặc tự đổi tên các bản xuất/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
5Nếu cần đổi tên một mục nhập đã đặt tên thì hãy sử dụng các thành phần của tên tệp hoặc đường dẫn của mô-đun đã nhập trong bí danh kết quả
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
63. 4. 2 xuất khẩu
Các biểu tượng chỉ được xuất nếu chúng được sử dụng bên ngoài mô-đun. Các ký hiệu cục bộ mô-đun không được xuất khẩu không được khai báo
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
94 cũng như tên của chúng không kết thúc bằng dấu gạch dưới. Không có thứ tự theo quy định cho các ký hiệu được xuất và mô-đun-cục bộ3. 4. 2. 1 Named vs default exportsSử dụng xuất khẩu có tên trong tất cả các mã. Bạn có thể áp dụng từ khóa
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
69 cho khai báo hoặc sử dụng cú pháp /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
507Không sử dụng xuất khẩu mặc định. Nhập mô-đun phải đặt tên cho các giá trị này, điều này có thể dẫn đến sự không nhất quán trong việc đặt tên giữa các mô-đun
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
7____08/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
93. 4. 2. 2 Xuất các lớp và đối tượng vùng chứa tĩnhKhông xuất các lớp hoặc đối tượng vùng chứa bằng các phương thức hoặc thuộc tính tĩnh vì mục đích tạo không gian tên
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
50Thay vào đó, hãy xuất các hằng số và hàm riêng lẻ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
513. 4. 2. 3 Tính biến động của hàng xuất khẩuCác biến đã xuất không được thay đổi bên ngoài quá trình khởi tạo mô-đun
Có các lựa chọn thay thế nếu cần thay đổi, bao gồm xuất một tham chiếu không đổi đến một đối tượng có các trường có thể thay đổi hoặc xuất các hàm truy cập cho dữ liệu có thể thay đổi
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
52/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
533. 4. 2. 4 xuất khẩu từCác câu lệnh
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
508 không được ngắt dòng và do đó là một ngoại lệ đối với giới hạn 80 cột. Điều này áp dụng cho cả hai hương vị /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
508/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
543. 4. 3 vòng phụ thuộc trong các mô-đun ES
Không tạo chu kỳ giữa các mô-đun ES, mặc dù đặc tả ECMAScript cho phép điều này. Lưu ý rằng có thể tạo chu trình bằng cả câu lệnh
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
68 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
69/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
55/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
56____3573. 4. 4 Tương tác với Đóng cửa
3. 4. 4. 1 Tham khảo googleĐể tham chiếu không gian tên Closure
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
512, nhập Closure's /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
513/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
58/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
513 chỉ xuất một tập hợp con các thuộc tính từ /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
512 toàn cầu có thể được sử dụng trong các mô-đun ES3. 4. 4. 2 tốt. yêu cầu trong các mô-đun ESCác mô-đun
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 trong ES hoạt động giống như trong các tệp /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66. Bạn có thể yêu cầu bất kỳ ký hiệu không gian tên Closure nào [i. e. , ký hiệu được tạo bởi /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
518 hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66] và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 sẽ trả về giá trị/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
593. 4. 4. 3 Khai báo ID mô-đun đóng trong mô-đun ESCó thể sử dụng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
521 trong các mô-đun ES để khai báo ID mô-đun giống như /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66. Điều này có nghĩa là ID mô-đun này có thể là /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74d, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
524d, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
525'd, v.v. như thể đó là một /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 không gọi cho /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
81. Nó không tạo ID mô-đun dưới dạng biểu tượng JavaScript có sẵn trên toàn cầuMột
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 [hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
524] cho ID mô-đun từ /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
521 sẽ luôn trả về đối tượng mô-đun [như thể nó là /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
504'd]. Do đó, đối số của _____3521 phải luôn kết thúc bằng _____3533Ghi chú. Có lỗi khi gọi
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
81 trong mô-đun ES, nó chỉ có thể được gọi từ các tệp /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66. Không có cách nào trực tiếp để liên kết một không gian tên kế thừa với một mô-đun ESChỉ nên sử dụng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
521 để nâng cấp tệp Đóng lên mô-đun ES tại chỗ, nơi sử dụng xuất có tên/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
603. 5 /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
537
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
Trong tệp
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66, câu lệnh /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 có thể tùy chọn được theo sau bởi lệnh gọi tới /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
540Trong một mô-đun ES, các câu lệnh
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
68 có thể tùy chọn được theo sau bởi một lệnh gọi tới /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
5403. 6 câu lệnh /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
Nhập khẩu được thực hiện với câu lệnh
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75. Các tên được nhập bởi một câu lệnh /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 có thể được sử dụng cả trong mã và trong các chú thích loại, trong khi những tên được nhập bởi một /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75 chỉ có thể được sử dụng trong các chú thích loạiCác câu lệnh
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75 tạo thành một khối liền kề không có dòng trống. Khối này tuân theo khai báo /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 được phân tách bằng một dòng trống. Toàn bộ đối số của /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75 là một không gian tên được xác định bởi một /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66 trong một tệp riêng biệt. /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 and /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75 statements may not appear anywhere else in the fileMỗi
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75 được gán cho một bí danh không đổi duy nhất hoặc nếu không thì được cấu trúc thành một số bí danh không đổi. Các bí danh này là cách duy nhất được chấp nhận để chỉ các phụ thuộc trong chú thích loại hoặc mã. Không được sử dụng các không gian tên đủ điều kiện ở bất cứ đâu, ngoại trừ làm đối số cho /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75Ngoại lệ. Các loại, biến và hàm được khai báo trong tệp bên ngoài phải sử dụng tên đủ điều kiện của chúng trong chú thích loại và mã
Bí danh phải khớp với thành phần cuối cùng được phân tách bằng dấu chấm trong không gian tên của mô-đun đã nhập
Ngoại lệ. Trong một số trường hợp nhất định, các thành phần bổ sung của không gian tên có thể được sử dụng để tạo bí danh dài hơn. Bí danh kết quả phải giữ lại cách viết hoa của mã định danh ban đầu để nó vẫn xác định chính xác loại của nó. Các bí danh dài hơn có thể được sử dụng để phân biệt các bí danh giống hệt nhau hoặc nếu nó cải thiện đáng kể khả năng đọc. Ngoài ra, phải sử dụng một bí danh dài hơn để ngăn che giấu các loại gốc như
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
561, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
562, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
563, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
564 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
565 [để biết danh sách đầy đủ hơn, hãy xem API Web và Đối tượng tích hợp sẵn tiêu chuẩn tại MDN]. Khi đổi tên các bí danh bị hủy cấu trúc, một khoảng trắng phải theo sau dấu hai chấm theo yêu cầu trong ??Một tệp không được chứa cả câu lệnh
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 và câu lệnh /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75 cho cùng một không gian tên. Nếu tên đã nhập được sử dụng cả trong chú thích mã và loại, thì tên đó phải được nhập bằng một câu lệnh /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74Nếu một mô-đun được nhập chỉ vì tác dụng phụ của nó, cuộc gọi phải là một
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 [không phải một /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75] và phép gán có thể bị bỏ qua. Cần có một bình luận để giải thích lý do tại sao điều này là cần thiết và loại bỏ cảnh báo của trình biên dịchCác dòng được sắp xếp theo các quy tắc sau. Tất cả các yêu cầu có tên ở phía bên trái được ưu tiên trước, được sắp xếp theo thứ tự bảng chữ cái của các tên đó. Sau đó, yêu cầu phá hủy, được sắp xếp lại theo tên ở phía bên trái. Cuối cùng, bất kỳ cuộc gọi yêu cầu nào độc lập [thường là những cuộc gọi này dành cho các mô-đun được nhập chỉ vì tác dụng phụ của chúng]
Mẹo. Không cần phải ghi nhớ lệnh này và thực thi thủ công. Bạn có thể dựa vào IDE của mình để báo cáo các yêu cầu không được sắp xếp chính xác
Nếu một bí danh hoặc tên mô-đun dài sẽ khiến một dòng vượt quá giới hạn 80 cột, thì nó không được ngắt dòng. các dòng yêu cầu là một ngoại lệ đối với giới hạn 80 cột
Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
61nản lòng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
62không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
633. 7 Việc triển khai tệp
Việc triển khai thực tế diễn ra sau khi tất cả thông tin phụ thuộc được khai báo [cách nhau ít nhất một dòng trống]
Điều này có thể bao gồm bất kỳ khai báo mô-đun-cục bộ nào [hằng, biến, lớp, hàm, v.v.], cũng như bất kỳ biểu tượng được xuất nào
4 Định dạng
Lưu ý thuật ngữ. cấu trúc giống như khối đề cập đến phần thân của một lớp, hàm, phương thức hoặc khối mã được phân cách bằng dấu ngoặc nhọn. Lưu ý rằng, bởi ??
Mẹo. Sử dụng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
571. Cộng đồng JavaScript đã đầu tư nỗ lực để đảm bảo clang-format hoạt động đúng trên các tệp JavaScript. /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
571 đã tích hợp với một số trình soạn thảo phổ biến4. 1 niềng răng
4. 1. 1 Niềng răng được sử dụng cho tất cả các cấu trúc điều khiển
Niềng răng được yêu cầu cho tất cả các cấu trúc điều khiển [i. e.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
573, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
574, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
575, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
576, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
577, cũng như bất kỳ cái nào khác], ngay cả khi phần nội dung chỉ chứa một câu lệnh duy nhất. Câu lệnh đầu tiên của một khối không trống phải bắt đầu trên dòng của chính nókhông được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
64Ngoại lệ. Một câu lệnh if đơn giản có thể vừa khít hoàn toàn trên một dòng mà không có dòng xuống dòng [và không có dòng nào khác] có thể được giữ trên một dòng không có dấu ngoặc khi nó cải thiện khả năng đọc. Đây là trường hợp duy nhất trong đó cấu trúc điều khiển có thể bỏ dấu ngoặc nhọn và dòng mới
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
654. 1. 2 khối rỗng. phong cách K&R
Dấu ngoặc theo kiểu Kernighan và Ritchie [dấu ngoặc của người Ai Cập] cho các khối không trống và các cấu trúc giống như khối
- Không ngắt dòng trước dấu ngoặc mở
- Line break after the opening brace
- Ngắt dòng trước dấu ngoặc nhọn
- Ngắt dòng sau dấu ngoặc nhọn nếu dấu ngoặc nhọn đó kết thúc câu lệnh hoặc phần thân của hàm hoặc câu lệnh lớp hoặc phương thức lớp. Cụ thể, không có ngắt dòng sau dấu ngoặc nhọn nếu theo sau nó là ________ 3574, ________ 3579, ________ 3577 hoặc dấu phẩy, dấu chấm phẩy hoặc dấu ngoặc đơn bên phải
Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
664. 1. 3 khối trống. có thể ngắn gọn
Một khối trống hoặc cấu trúc giống như khối có thể được đóng lại ngay sau khi nó được mở ra, không có ký tự, dấu cách hoặc ngắt dòng ở giữa [i. e.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
581], trừ khi nó là một phần của câu lệnh nhiều khối [câu lệnh chứa trực tiếp nhiều khối. /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
573//* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
574 hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
584//* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
579//* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
586]Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
67không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
684. 2 Khối thụt đầu dòng. +2 dấu cách
Mỗi khi một khối mới hoặc cấu trúc giống như khối được mở, phần thụt lề sẽ tăng thêm hai khoảng trắng. Khi khối kết thúc, thụt lề trở về mức thụt lề trước đó. Mức thụt lề áp dụng cho cả mã và nhận xét trong toàn bộ khối. [Xem ví dụ trong ??]
4. 2. 1 mảng chữ. giống như khối tùy chọn
Bất kỳ mảng chữ nào cũng có thể được định dạng tùy chọn như thể nó là một “cấu trúc giống như khối. ” Ví dụ: tất cả những điều sau đây đều hợp lệ [không phải là danh sách đầy đủ]
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
69/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
10Các kết hợp khác được cho phép, đặc biệt khi nhấn mạnh các nhóm ngữ nghĩa giữa các phần tử, nhưng không nên chỉ được sử dụng để giảm kích thước dọc của các mảng lớn hơn
4. 2. 2 đối tượng chữ. giống như khối tùy chọn
Bất kỳ đối tượng theo nghĩa đen nào cũng có thể được định dạng tùy chọn như thể nó là một “cấu trúc giống như khối. ” Các ví dụ tương tự được áp dụng như ??. Ví dụ: tất cả những điều sau đây đều hợp lệ [không phải là danh sách đầy đủ]
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
11/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
124. 2. 3 Lớp chữ
Các ký tự lớp [dù là khai báo hay biểu thức] được thụt vào dưới dạng khối. Không thêm dấu chấm phẩy sau các phương thức hoặc sau dấu ngoặc nhọn đóng của một khai báo lớp [các câu lệnh—chẳng hạn như các phép gán—có chứa các biểu thức lớp vẫn được kết thúc bằng dấu chấm phẩy]. Sử dụng từ khóa
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
587, nhưng không phải chú thích /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
588 JSDoc trừ khi lớp mở rộng một loại được tạo khuôn mẫuThí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
13/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
144. 2. 4 Biểu thức hàm
Khi khai báo một hàm ẩn danh trong danh sách các đối số cho một lệnh gọi hàm, phần thân của hàm được thụt lề nhiều hơn hai khoảng trắng so với độ sâu thụt lề trước đó
Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
154. 2. 5 Câu lệnh chuyển đổi
Như với bất kỳ khối nào khác, nội dung của khối chuyển đổi được thụt vào +2
Sau nhãn chuyển đổi, một dòng mới xuất hiện và mức thụt đầu dòng được tăng lên +2, chính xác như thể một khối đang được mở. Một khối rõ ràng có thể được sử dụng nếu được yêu cầu bởi phạm vi từ vựng. Nhãn công tắc sau trở về mức thụt đầu dòng trước đó, như thể một khối đã bị đóng
A blank line is optional between a
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
589 and the following caseThí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
164. 3 Tuyên bố
4. 3. 1 Một câu lệnh trên mỗi dòng
Mỗi câu lệnh được theo sau bởi một dấu ngắt dòng
4. 3. 2 dấu chấm phẩy là bắt buộc
Mọi câu lệnh phải được kết thúc bằng dấu chấm phẩy. Dựa vào chèn dấu chấm phẩy tự động bị cấm
4. 4 Giới hạn cột. 80
Mã JavaScript có giới hạn cột là 80 ký tự. Ngoại trừ như được lưu ý bên dưới, bất kỳ dòng nào vượt quá giới hạn này đều phải được ngắt dòng, như được giải thích trong ??
ngoại lệ
- Câu lệnh
66,/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
74 và/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
75 [xem ?? và ??]/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Câu lệnh mô-đun ES
68 và/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
508 [xem ?? và ??]/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Các dòng không thể tuân theo giới hạn cột hoặc sẽ cản trở khả năng khám phá. Những ví dụ bao gồm
- Một URL dài có thể nhấp được trong nguồn
- Một lệnh trình bao dự định được sao chép và dán
- Một chuỗi ký tự dài có thể cần được sao chép hoặc tìm kiếm toàn bộ [e. g. , một đường dẫn tệp dài]
4. 5 Đóng gói dòng
Lưu ý thuật ngữ. Ngắt dòng đang chia một đoạn mã thành nhiều dòng để tuân theo giới hạn của cột, trong đó đoạn mã đó có thể nằm gọn trong một dòng một cách hợp pháp
Không có công thức toàn diện, xác định nào chỉ ra chính xác cách ngắt dòng trong mọi tình huống. Rất thường có một số cách hợp lệ để ngắt dòng cùng một đoạn mã
Ghi chú. Mặc dù lý do điển hình của việc ngắt dòng là để tránh vượt quá giới hạn cột, nhưng ngay cả mã thực tế phù hợp với giới hạn cột cũng có thể được ngắt dòng theo quyết định của tác giả
Mẹo. Trích xuất một phương thức hoặc biến cục bộ có thể giải quyết vấn đề mà không cần phải ngắt dòng
4. 5. 1 Nơi để phá vỡ
Chỉ thị chính của line-wrapping là. thích phá vỡ ở cấp độ cú pháp cao hơn
ưa thích
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
17nản lòng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
18Trong ví dụ trước, các mức cú pháp từ cao nhất đến thấp nhất như sau. gán, chia, gọi hàm, tham số, hằng số
Toán tử được gói như sau
- Khi một dòng bị ngắt tại một toán tử, dấu ngắt xuất hiện sau ký hiệu. [Lưu ý rằng đây không phải là cách làm tương tự được sử dụng theo phong cách Google dành cho Java. ]
- Điều này không áp dụng cho dấu chấm [
595], thực tế không phải là toán tử/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Điều này không áp dụng cho dấu chấm [
- Tên phương thức hoặc hàm tạo được gắn vào dấu ngoặc đơn mở [
596] theo sau nó/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Dấu phẩy [
597] vẫn được gắn vào mã thông báo đứng trước nó/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
Ghi chú. Mục tiêu chính của việc ngắt dòng là có mã rõ ràng, không nhất thiết là mã phù hợp với số lượng dòng nhỏ nhất
4. 5. 2 dòng tiếp tục thụt lề ít nhất +4 dấu cách
Khi ngắt dòng, mỗi dòng sau dòng đầu tiên [mỗi dòng tiếp theo] được thụt vào ít nhất +4 so với dòng ban đầu, trừ khi nó tuân theo quy tắc thụt lề khối
Khi có nhiều dòng tiếp tục, thụt đầu dòng có thể thay đổi ngoài +4 khi thích hợp. Nói chung, các dòng tiếp tục ở cấp độ cú pháp sâu hơn được thụt vào bởi các bội số lớn hơn của 4 và hai dòng sử dụng cùng một mức độ thụt đầu dòng khi và chỉ khi chúng bắt đầu bằng các yếu tố song song về mặt cú pháp
??
4. 6 Khoảng trắng
4. 6. 1 Khoảng trắng dọc
Một dòng trống duy nhất xuất hiện
- Giữa các phương thức liên tiếp trong một lớp hoặc đối tượng theo nghĩa đen
- Exception. Một dòng trống giữa hai định nghĩa thuộc tính liên tiếp trong một đối tượng bằng chữ [không có mã nào khác giữa chúng] là tùy chọn. Các dòng trống như vậy được sử dụng khi cần thiết để tạo các nhóm trường hợp lý
- Trong nội dung phương thức, tiết kiệm để tạo các nhóm câu lệnh logic. Các dòng trống ở đầu hoặc cuối thân hàm không được phép
- Tùy chọn trước phương thức đầu tiên hoặc sau phương thức cuối cùng trong một lớp hoặc đối tượng theo nghĩa đen [không được khuyến khích cũng không được khuyến khích]
- Theo yêu cầu của các phần khác của tài liệu này [e. g. ??]
Nhiều dòng trống liên tiếp được cho phép, nhưng không bao giờ bắt buộc [cũng không được khuyến khích]
4. 6. 2 Khoảng trắng ngang
Việc sử dụng khoảng trắng ngang phụ thuộc vào vị trí và thuộc ba loại chính. đầu [ở đầu dòng], theo sau [ở cuối dòng] và nội bộ. Khoảng trắng hàng đầu [i. e. , thụt đầu dòng] được giải quyết ở nơi khác. Khoảng trắng ở cuối bị cấm
Ngoài những nơi được yêu cầu bởi ngôn ngữ hoặc các quy tắc kiểu dáng khác và ngoài chữ, nhận xét và JSDoc, một không gian ASCII bên trong cũng chỉ xuất hiện ở những vị trí sau
- Tách bất kỳ từ dành riêng nào [chẳng hạn như
573,/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
575 hoặc/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
579] ngoại trừ/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
601 và/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
602, khỏi dấu ngoặc đơn mở [/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
596] theo sau từ đó trên dòng đó/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Tách bất kỳ từ dành riêng nào [chẳng hạn như
574 hoặc/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
579] khỏi dấu ngoặc nhọn đóng [/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
606] đứng trước từ đó trên dòng đó/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Trước bất kỳ dấu ngoặc nhọn mở nào [______3607], với hai ngoại lệ
- Trước một ký tự đối tượng là đối số đầu tiên của một hàm hoặc phần tử đầu tiên trong một ký tự mảng [e. g.
608]/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Trong bản mở rộng mẫu, vì nó bị cấm bởi ngôn ngữ [e. g. có giá trị.
609, không hợp lệ./* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
610]/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Trước một ký tự đối tượng là đối số đầu tiên của một hàm hoặc phần tử đầu tiên trong một ký tự mảng [e. g.
- Trên cả hai mặt của bất kỳ toán tử nhị phân hoặc bậc ba nào
- Sau dấu phẩy [
597] hoặc dấu chấm phẩy [/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
612]. Lưu ý rằng khoảng cách không bao giờ được phép trước các ký tự này/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Sau dấu hai chấm [
613] trong một đối tượng theo nghĩa đen/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Ở cả hai bên của dấu gạch chéo kép [
614] bắt đầu nhận xét cuối dòng. Ở đây, nhiều khoảng trắng được cho phép, nhưng không bắt buộc/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Sau một ký tự bình luận khối mở và ở cả hai bên của các ký tự đóng [e. g. cho các khai báo kiểu dạng ngắn, ép kiểu và nhận xét tên tham số.
615;/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
4. 6. 3 Căn ngang. chán nản
Lưu ý thuật ngữ. Căn chỉnh theo chiều ngang là cách thêm một số khoảng trắng bổ sung có thể thay đổi vào mã của bạn với mục tiêu làm cho một số mã thông báo nhất định xuất hiện ngay bên dưới một số mã thông báo khác trên các dòng trước đó
Phương pháp này được cho phép, nhưng nó thường không được Google Style khuyến khích. Thậm chí không bắt buộc phải duy trì căn chỉnh ngang ở những nơi nó đã được sử dụng
Đây là một ví dụ không có căn chỉnh, theo sau là một ví dụ có căn chỉnh. Cả hai đều được phép, nhưng cái sau không được khuyến khích
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
19Mẹo. Căn chỉnh có thể hỗ trợ khả năng đọc, nhưng nó tạo ra các vấn đề cho việc bảo trì trong tương lai. Xem xét một thay đổi trong tương lai chỉ cần chạm vào một dòng. Thay đổi này có thể khiến định dạng hài lòng trước đây bị xáo trộn và điều đó được cho phép. Thông thường, nó cũng nhắc người viết mã [có thể là bạn] điều chỉnh khoảng trắng trên các dòng gần đó, có thể kích hoạt một loạt định dạng lại xếp tầng. Thay đổi một dòng đó hiện có bán kính vụ nổ. Điều này tệ nhất có thể dẫn đến công việc bận rộn vô nghĩa, nhưng tốt nhất thì nó vẫn làm hỏng thông tin lịch sử phiên bản, làm chậm người đánh giá và làm trầm trọng thêm xung đột hợp nhất
4. 6. 4 Đối số chức năng
Prefer to put all function arguments on the same line as the function name. Nếu làm như vậy sẽ vượt quá giới hạn 80 cột, các đối số phải được ngắt dòng theo cách có thể đọc được. Để tiết kiệm dung lượng, bạn có thể ngắt dòng càng gần 80 càng tốt hoặc đặt mỗi đối số trên một dòng riêng để dễ đọc hơn. Thụt đầu dòng phải là bốn khoảng trắng. Căn chỉnh theo dấu ngoặc đơn được cho phép, nhưng không được khuyến khích. Dưới đây là các mẫu phổ biến nhất để gói đối số
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
204. 7 Nhóm dấu ngoặc đơn. khuyến khích
Các dấu ngoặc nhóm tùy chọn chỉ được bỏ qua khi tác giả và người đánh giá đồng ý rằng không có khả năng mã sẽ bị hiểu sai nếu không có chúng, cũng như chúng sẽ không làm cho mã dễ đọc hơn. Không hợp lý khi cho rằng mọi đầu đọc đều ghi nhớ toàn bộ bảng ưu tiên toán tử
Không sử dụng dấu ngoặc đơn không cần thiết xung quanh toàn bộ biểu thức sau
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
618, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
619, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
620, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
621, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
622, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
623, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
624, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
625 hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
626Dấu ngoặc đơn là bắt buộc đối với kiểu phôi.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
627Phần này giải quyết các ý kiến thực hiện. JSDoc được xử lý riêng trong ??
Nhận xét khối được thụt lề ở cùng mức với mã xung quanh. Chúng có thể ở kiểu
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
628 hoặc kiểu /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
614. Đối với nhận xét nhiều dòng /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
628, các dòng tiếp theo phải bắt đầu bằng * được căn chỉnh với /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
631 trên dòng trước đó, để làm cho nhận xét rõ ràng mà không có ngữ cảnh bổ sung/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
21Nhận xét không được đặt trong các hộp được vẽ bằng dấu hoa thị hoặc các ký tự khác
Không sử dụng JSDoc [______048] để nhận xét triển khai
Nhận xét "Tên tham số" nên được sử dụng bất cứ khi nào giá trị và tên phương thức không truyền đạt đầy đủ ý nghĩa và việc tái cấu trúc phương thức để rõ ràng hơn là không khả thi. Định dạng ưa thích của họ là trước giá trị với =
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
22Để thống nhất với mã xung quanh, bạn có thể đặt chúng sau giá trị mà không có =
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
235 Tính năng ngôn ngữ
JavaScript bao gồm nhiều tính năng đáng ngờ [và thậm chí nguy hiểm]. Phần này mô tả những tính năng nào có thể được sử dụng hoặc không được sử dụng và mọi ràng buộc bổ sung đối với việc sử dụng chúng
5. 1 Khai báo biến cục bộ
5. 1. 1 Sử dụng /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
633 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
634
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
Khai báo tất cả các biến cục bộ bằng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
633 hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
634. Sử dụng const theo mặc định, trừ khi một biến cần được gán lại. Không được sử dụng từ khóa /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
6375. 1. 2 Mỗi khai báo một biến
Mỗi khai báo biến cục bộ chỉ khai báo một biến. khai báo như
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
638 không được sử dụng5. 1. 3 Khai báo khi cần thiết, khởi tạo ngay khi có thể
Các biến cục bộ không được khai báo theo thói quen khi bắt đầu khối chứa hoặc cấu trúc giống như khối của chúng. Thay vào đó, các biến cục bộ được khai báo gần với điểm chúng được sử dụng lần đầu tiên [với lý do], để giảm thiểu phạm vi của chúng
5. 1. 4 Khai báo các loại theo nhu cầu
Các chú thích kiểu JSDoc có thể được thêm vào dòng phía trên khai báo hoặc nội tuyến khác trước tên biến nếu không có JSDoc nào khác xuất hiện
Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
24Không được phép trộn các kiểu nội tuyến và JSDoc. trình biên dịch sẽ chỉ xử lý JsDoc đầu tiên và các chú thích nội tuyến sẽ bị mất
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
25Mẹo. Có nhiều trường hợp trình biên dịch có thể suy ra một kiểu đã được tạo khuôn mẫu nhưng không thể suy ra các tham số của nó. Đây là trường hợp đặc biệt khi lời gọi khởi tạo bằng chữ hoặc hàm tạo không bao gồm bất kỳ giá trị nào của loại tham số mẫu [e. g. , mảng trống, đối tượng,
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
564 hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
640] hoặc nếu biến được sửa đổi trong một bao đóng. Chú thích loại biến cục bộ đặc biệt hữu ích trong những trường hợp này vì nếu không, trình biên dịch sẽ suy ra tham số mẫu là không xác định5. 2 Array literals
5. 2. 1 Sử dụng dấu phẩy sau
Bao gồm dấu phẩy ở cuối bất cứ khi nào có dấu ngắt dòng giữa phần tử cuối cùng và dấu ngoặc đóng
Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
265. 2. 2 Không sử dụng hàm tạo biến đổi /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
641
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
Hàm tạo dễ bị lỗi nếu các đối số được thêm hoặc xóa. Sử dụng một nghĩa đen thay thế
không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
27Điều này hoạt động như mong đợi ngoại trừ trường hợp thứ ba. nếu
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
642 là một số nguyên thì /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
643 là một mảng có kích thước /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
642 trong đó tất cả các phần tử là /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
645. Nếu /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
642 là bất kỳ số nào khác, thì một ngoại lệ sẽ được đưa ra và nếu đó là bất kỳ số nào khác thì nó sẽ là một mảng một phần tửThay vào đó, hãy viết
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
28Cho phép phân bổ rõ ràng một mảng có độ dài nhất định bằng cách sử dụng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
647 khi thích hợp5. 2. 3 Thuộc tính phi số
Không xác định hoặc sử dụng các thuộc tính không phải là số trên một mảng [ngoài
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
648]. Thay vào đó, hãy sử dụng /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
564 [hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
650]5. 2. 4 Phá hủy
Các ký tự mảng có thể được sử dụng ở phía bên trái của phép gán để thực hiện hủy [chẳng hạn như khi giải nén nhiều giá trị từ một mảng hoặc có thể lặp lại]. Phần tử còn lại cuối cùng có thể được bao gồm [không có khoảng cách giữa
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
651 và tên biến]. Các yếu tố nên được bỏ qua nếu chúng không được sử dụng/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
29Việc hủy cấu trúc cũng có thể được sử dụng cho các tham số chức năng [lưu ý rằng tên tham số là bắt buộc nhưng có thể bỏ qua]. Luôn chỉ định
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
652 làm giá trị mặc định nếu tham số mảng bị hủy cấu trúc là tùy chọn và cung cấp các giá trị mặc định ở phía bên trái/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
30không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
31Mẹo. Để [không] đóng gói nhiều giá trị vào một tham số hoặc hàm trả về, hãy ưu tiên hủy đối tượng hơn là hủy mảng khi có thể, vì nó cho phép đặt tên các phần tử riêng lẻ và chỉ định một loại khác nhau cho từng phần tử
5. 2. 5 Toán tử trải rộng
Các ký tự mảng có thể bao gồm toán tử trải rộng [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
651] để làm phẳng các phần tử ra khỏi một hoặc nhiều lần lặp khác. Toán tử trải rộng nên được sử dụng thay vì các cấu trúc khó xử hơn với /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
654. Không có khoảng trống sau /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
651Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
325. 3 đối tượng chữ
5. 3. 1 Sử dụng dấu phẩy sau
Bao gồm dấu phẩy ở cuối bất cứ khi nào có dấu ngắt dòng giữa thuộc tính cuối cùng và dấu ngoặc nhọn đóng
5. 3. 2 Không sử dụng hàm tạo /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
650
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
Mặc dù
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
650 không gặp vấn đề giống như /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
641, nhưng nó vẫn không được phép vì tính nhất quán. Thay vào đó, hãy sử dụng một đối tượng bằng chữ [/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
581 hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
660]5. 3. 3 Không trộn lẫn các phím được trích dẫn và không được trích dẫn
Các ký tự đối tượng có thể đại diện cho các cấu trúc [với các khóa và/hoặc ký hiệu không được trích dẫn] hoặc các ký tự [với các khóa được trích dẫn và/hoặc được tính toán]. Không trộn lẫn các loại khóa này trong một đối tượng theo nghĩa đen
không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
33Điều này cũng mở rộng để chuyển tên thuộc tính cho các hàm, như
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
661. Cụ thể, làm như vậy sẽ phá vỡ mã được biên dịch vì trình biên dịch không thể đổi tên/làm xáo trộn chuỗi ký tựkhông được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
34Điều này được thực hiện tốt nhất như
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
355. 3. 4 Tên thuộc tính được tính toán
Tên thuộc tính được tính toán [e. g. ,
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
662] được cho phép và được coi là khóa kiểu chính tả [được trích dẫn] [i. e. , không được trộn lẫn với các khóa không được trích dẫn] trừ khi thuộc tính được tính là ký hiệu [e. g. , /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
663]. Các giá trị enum cũng có thể được sử dụng cho các khóa được tính toán, nhưng không được trộn lẫn với các khóa không phải enum theo cùng một nghĩa đen5. 3. 5 Phương pháp tốc ký
Methods can be defined on object literals using the method shorthand [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
664] in place of a colon immediately followed by a /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
601 or arrow function literalThí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
36Lưu ý rằng ________ 3666 trong một phương thức tốc ký hoặc
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
601 đề cập đến chính đối tượng theo nghĩa đen trong khi ________ 3666 trong một hàm mũi tên đề cập đến phạm vi bên ngoài đối tượng theo nghĩa đenThí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
375. 3. 6 thuộc tính tốc ký
Thuộc tính tốc ký được phép trên đối tượng chữ
Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
385. 3. 7 Destructuring
Các mẫu phá hủy đối tượng có thể được sử dụng ở phía bên trái của một nhiệm vụ để thực hiện phá hủy và giải nén nhiều giá trị từ một đối tượng
Các đối tượng bị hủy cấu trúc cũng có thể được sử dụng làm tham số chức năng, nhưng phải được giữ càng đơn giản càng tốt. một cấp duy nhất của các thuộc tính tốc ký không được trích dẫn. Các cấp độ sâu hơn của các thuộc tính được tính toán và lồng nhau có thể không được sử dụng trong quá trình phá hủy tham số. Chỉ định bất kỳ giá trị mặc định nào ở phía bên trái của tham số đã hủy cấu trúc [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
669, thay vì /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
670] và nếu bản thân đối tượng đã hủy cấu trúc là tùy chọn, thì đối tượng đó phải được đặt mặc định là /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
581. JSDoc cho tham số bị hủy cấu trúc có thể được đặt bất kỳ tên nào [tên này không được sử dụng nhưng được yêu cầu bởi trình biên dịch]Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
39không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
60Destructuring may also be used for
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 statements, and in this case must not be wrapped. the entire statement occupies one line, regardless of how long it is [see ??]5. 3. 8 Enums
Enumerations are defined by adding the
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
673 annotation to an object literal. Additional properties may not be added to an enum after it is defined. Enums must be constant, and all enum values must be deeply immutable/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
615. 4 Classes
5. 4. 1 Constructors
Constructor là tùy chọn. Các hàm tạo của lớp con phải gọi
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
674 trước khi đặt bất kỳ trường nào hoặc truy cập vào /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
666. Các giao diện nên khai báo các thuộc tính phi phương thức trong hàm tạo5. 4. 2 trường
Đặt tất cả các trường của một đối tượng cụ thể [i. e. tất cả các thuộc tính khác với phương thức] trong hàm tạo. Chú thích các trường không bao giờ được gán lại với
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
96 [những trường này không cần phải quá bất biến]. Chú thích các trường không công khai bằng chú thích khả năng hiển thị phù hợp [/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
94, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
678, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
679] và kết thúc tên của tất cả các trường /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
94 bằng dấu gạch dưới. Fields are never set on a concrete class' /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
681Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
62Tip. Không bao giờ được thêm hoặc xóa các thuộc tính khỏi một phiên bản sau khi hàm tạo kết thúc, vì nó cản trở đáng kể khả năng tối ưu hóa của máy ảo. If necessary, fields that are initialized later should be explicitly set to
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
645 in the constructor to prevent later shape changes. Adding /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
683 to an object will check that undeclared properties are not added/accessed. Classes have this added by default5. 4. 3 Computed properties
Computed properties may only be used in classes when the property is a symbol. Dict-style properties [that is, quoted or computed non-symbol keys, as defined in ??] are not allowed. A
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
663 method should be defined for any classes that are logically iterable. Beyond this, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
685 should be used sparinglyTip. be careful of using any other built-in symbols [e. g. ,
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
686] as they are not polyfilled by the compiler and will therefore not work in older browsers5. 4. 4 Static methods
Where it does not interfere with readability, prefer module-local functions over private static methods
Static methods should only be called on the base class itself. Static methods should not be called on variables containing a dynamic instance that may be either the constructor or a subclass constructor [and must be defined with
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
687 if this is done], and must not be called directly on a subclass that doesn’t define the method itselfkhông được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
635. 4. 5 Old-style class declarations
While ES6 classes are preferred, there are cases where ES6 classes may not be feasible. For example
If there exist or will exist subclasses, including frameworks that create subclasses, that cannot be immediately changed to use ES6 class syntax. If such a class were to use ES6 syntax, all downstream subclasses not using ES6 class syntax would need to be modified
Frameworks that require a known
666 value before calling the superclass constructor, since constructors with ES6 super classes do not have access to the instance/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
666 value until the call to/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
602 returns/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
In all other ways the style guide still applies to this code.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
634, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
633, default parameters, rest, and arrow functions should all be used when appropriate/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
693 allows for a class-like definition similar to ES6 class syntax/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
64Alternatively, while
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
693 should be preferred for all new code, more traditional syntax is also allowed/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
65Per-instance properties should be defined in the constructor after the call to the super class constructor, if there is a super class. Methods should be defined on the prototype of the constructor
Defining constructor prototype hierarchies correctly is harder than it first appears. For that reason, it is best to use
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
695 from the Closure Library 5. 4. 6 Do not manipulate /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
681s directly
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
The
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
697 keyword allows clearer and more readable class definitions than defining /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
681 properties. Ordinary implementation code has no business manipulating these objects, though they are still useful for defining classes as defined in ??. Mixins and modifying the prototypes of builtin objects are explicitly forbiddenException. Framework code [such as Polymer, or Angular] may need to use
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
681s, and should not resort to even-worse workarounds to avoid doing so5. 4. 7 Getters and Setters
Do not use JavaScript getter and setter properties. They are potentially surprising and difficult to reason about, and have limited support in the compiler. Provide ordinary methods instead
Exception. there are situations where defining a getter or setter is unavoidable [e. g. data binding frameworks such as Angular and Polymer, or for compatibility with external APIs that cannot be adjusted]. In these cases only, getters and setters may be used with caution, provided they are defined with the
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
100 and /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
101 shorthand method keywords or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
102 [not /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
103, which interferes with property renaming]. Getters must not change observable statekhông được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
665. 4. 8 Overriding toString
The
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
104 method may be overridden, but must always succeed and never have visible side effectsTip. Beware, in particular, of calling other methods from toString, since exceptional conditions could lead to infinite loops
5. 4. 9 Interfaces
Interfaces may be declared with
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
105 or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
106. Interfaces declared with /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
106 can be explicitly [i. e. via /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
108] or implicitly implemented by a class or object literalAll non-static method bodies on an interface must be empty blocks. Fields must be declared as uninitialized members in the class constructor
Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
675. 4. 10 Abstract Classes
Use abstract classes when appropriate. Abstract classes and methods must be annotated with
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
109. Do not use /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
110. See abstract classes and methods5. 5 Functions
5. 5. 1 Top-level functions
Top-level functions may be defined directly on the
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
92 object, or else declared locally and optionally exported. See ?? for more on exportsví dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
68/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
695. 5. 2 Nested functions and closures
Functions may contain nested function definitions. If it is useful to give the function a name, it should be assigned to a local
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
6335. 5. 3 Arrow functions
Arrow functions provide a concise function syntax and simplify scoping
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
666 for nested functions. Prefer arrow functions over the /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
601 keyword, particularly for nested functions [but see ??]Prefer arrow functions over other
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
666 scoping approaches such as /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
116, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
117, and /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
118. Arrow functions are particularly useful for calling into callbacks as they permit explicitly specifying which parameters to pass to the callback whereas binding will blindly pass along all parametersThe left-hand side of the arrow contains zero or more parameters. Dấu ngoặc đơn xung quanh các tham số là tùy chọn nếu chỉ có một tham số không bị hủy cấu trúc. Khi sử dụng dấu ngoặc đơn, các loại tham số nội tuyến có thể được chỉ định [xem ??]
Mẹo. Việc luôn sử dụng dấu ngoặc đơn ngay cả đối với các hàm mũi tên có một tham số có thể tránh được các trường hợp khi thêm tham số nhưng quên thêm dấu ngoặc đơn, có thể dẫn đến mã có thể phân tích cú pháp không còn hoạt động như dự kiến
Phía bên phải của mũi tên chứa phần thân của hàm. By default the body is a block statement [zero or more statements surrounded by curly braces]. The body may also be an implicitly returned single expression if either. the program logic requires returning a value, or the
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
620 operator precedes a single function or method call [using /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
620 ensures /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
645 is returned, prevents leaking values, and communicates intent]. The single expression form is preferred if it improves readability [e. g. , for short or simple expressions]ví dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
90không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
915. 5. 4 Generators
Generators enable a number of useful abstractions and may be used as needed
When defining generator functions, attach the
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
631 to the /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
601 keyword when present, and separate it with a space from the name of the function. When using delegating yields, attach the /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
631 to the /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
626 keywordThí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
925. 5. 5 Parameter and return types
Function parameters and return types should usually be documented with JSDoc annotations. See ?? for more information
5. 5. 5. 1 Default parametersOptional parameters are permitted using the equals operator in the parameter list. Optional parameters must include spaces on both sides of the equals operator, be named exactly like required parameters [i. e. , not prefixed with
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
126], use the /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
127 suffix in their JSDoc type, come after required parameters, and not use initializers that produce observable side effects. All optional parameters for concrete functions must have default values, even if that value is /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
645. In contrast to concrete functions, abstract and interface methods must omit default parameter valuesThí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
93Use default parameters sparingly. Prefer destructuring [as in ??] to create readable APIs when there are more than a small handful of optional parameters that do not have a natural order
Note. Unlike Python's default parameters, it is okay to use initializers that return new mutable objects [such as
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
581 or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
652] because the initializer is evaluated each time the default value is used, so a single object won't be shared across invocationsTip. While arbitrary expressions including function calls may be used as initializers, these should be kept as simple as possible. Avoid initializers that expose shared mutable state, as that can easily introduce unintended coupling between function calls
5. 5. 5. 2 Rest parametersUse a rest parameter instead of accessing
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
131. Rest parameters are typed with a /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
651 prefix in their JSDoc. The rest parameter must be the last parameter in the list. There is no space between the /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
651 and the parameter name. Do not name the rest parameter /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
134. Never name a local variable or parameter /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
131, which confusingly shadows the built-in nameThí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
945. 5. 6 Generics
Declare generic functions and methods when necessary with
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
136 in the JSDoc above the function or method definition5. 5. 7 Spread operator
Function calls may use the spread operator [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
651]. Prefer the spread operator to /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
138 when an array or iterable is unpacked into multiple parameters of a variadic function. There is no space after the /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
651Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
955. 6 String literals
5. 6. 1 Use single quotes
Ordinary string literals are delimited with single quotes [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
140], rather than double quotes [/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
141]Tip. if a string contains a single quote character, consider using a template string to avoid having to escape the quote
Ordinary string literals may not span multiple lines
5. 6. 2 Chữ mẫu
Sử dụng các ký tự mẫu [được phân tách bằng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
142] trên cách nối chuỗi phức tạp, đặc biệt nếu có nhiều ký tự chuỗi liên quan. Mẫu chữ có thể kéo dài nhiều dòngIf a template literal spans multiple lines, it does not need to follow the indentation of the enclosing block, though it may if the added whitespace does not matter
Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
965. 6. 3 No line continuations
Không sử dụng các phần tiếp theo của dòng [nghĩa là kết thúc một dòng bên trong một chuỗi ký tự bằng dấu gạch chéo ngược] bằng ký tự chuỗi thông thường hoặc chuỗi mẫu. Mặc dù ES5 cho phép điều này, nhưng nó có thể dẫn đến các lỗi phức tạp nếu có bất kỳ khoảng trắng ở cuối nào xuất hiện sau dấu gạch chéo và ít rõ ràng hơn đối với người đọc
không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
97Thay vào đó, hãy viết
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
985. 7 Number literals
Numbers may be specified in decimal, hex, octal, or binary. Use exactly
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
143, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
144, and /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
145 prefixes, with lowercase letters, for hex, octal, and binary, respectively. Never include a leading zero unless it is immediately followed by /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
146, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
147, or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
1485. 8 Control structures
5. 8. 1 For loops
With ES6, the language now has three different kinds of
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
575 loops. All may be used, though /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
575-/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
625 loops should be preferred when possible/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
575-/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
624 loops may only be used on dict-style objects [see ??], and should not be used to iterate over an array. /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
154 should be used in /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
575-/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
624 loops to exclude unwanted prototype properties. Prefer /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
575-/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
625 and /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
159 over /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
575-/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
624 when possible5. 8. 2 Exceptions
Exceptions are an important part of the language and should be used whenever exceptional cases occur. Always throw
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
563s or subclasses of /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
563. never throw string literals or other objects. Always use /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
164 when constructing an /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
563This treatment extends to
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
565 rejection values as /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
167 is equivalent to /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
168 in async functionsCustom exceptions provide a great way to convey additional error information from functions. They should be defined and used wherever the native
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
563 type is insufficientPrefer throwing exceptions over ad-hoc error-handling approaches [such as passing an error container reference type, or returning an object with an error property]
It is very rarely correct to do nothing in response to a caught exception. When it truly is appropriate to take no action whatsoever in a catch block, the reason this is justified is explained in a comment
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
99không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
10Mẹo. Unlike in some other languages, patterns like the above simply don’t work since this will catch the error thrown by
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
170. Use /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
171 instead5. 8. 3 Switch statements
Terminology Note. Inside the braces of a switch block are one or more statement groups. Each statement group consists of one or more switch labels [either
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
172 or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
173], followed by one or more statements5. 8. 3. 1 Fall-through. commentedTrong một khối chuyển đổi, mỗi nhóm câu lệnh hoặc kết thúc đột ngột [với ngoại lệ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
589, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
621 hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
622n] hoặc được đánh dấu bằng một nhận xét để chỉ ra rằng việc thực thi sẽ hoặc có thể tiếp tục trong nhóm câu lệnh tiếp theo. Any comment that communicates the idea of fall-through is sufficient [typically /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
177]. Chú thích đặc biệt này không bắt buộc trong nhóm câu lệnh cuối cùng của khối chuyển đổiThí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
115. 8. 3. 2 The /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
178 case is presentEach switch statement includes a
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
178 statement group, even if it contains no code. The /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
178 statement group must be last5. 9 this
Only use
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
666 in class constructors and methods, in arrow functions defined within class constructors and methods, or in functions that have an explicit /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
182 declared in the immediately-enclosing function’s JSDocNever use
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
666 to refer to the global object, the context of an /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
184, the target of an event, or unnecessarily /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
185ed or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
186ed functions5. 10 Equality Checks
Use identity operators [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
187//* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
188] except in the cases documented below5. 10. 1 Exceptions Where Coercion is Desirable
Catching both
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
189 and /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
645 values/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
125. 11 Disallowed features
5. 11. 1 with
Do not use the
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
191 keyword. It makes your code harder to understand and has been banned in strict mode since ES55. 11. 2 Dynamic code evaluation
Do not use
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
184 or the /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
193 constructor [except for code loaders]. These features are potentially dangerous and simply do not work in CSP environments5. 11. 3 Automatic semicolon insertion
Always terminate statements with semicolons [except function and class declarations, as noted above]
5. 11. 4 Non-standard features
Do not use non-standard features. This includes old features that have been removed [e. g. ,
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
194], new features that are not yet standardized [e. g. , the current TC39 working draft, proposals at any stage, or proposed but not-yet-complete web standards], or proprietary features that are only implemented in some browsers. Use only features defined in the current ECMA-262 or WHATWG standards. [Note that projects writing against specific APIs, such as Chrome extensions or Node. js, can obviously use those APIs]. Non-standard language “extensions” [such as those provided by some external transpilers] are forbidden5. 11. 5 Wrapper objects for primitive types
Never use
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
164 on the primitive object wrappers [/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
196, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
197, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
198, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
685], nor include them in type annotationskhông được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
13The wrappers may be called as functions for coercing [which is preferred over using
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
200 or concatenating the empty string] or creating symbolsThí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
145. 11. 6 Modifying builtin objects
Never modify builtin types, either by adding methods to their constructors or to their prototypes. Avoid depending on libraries that do this. Note that the JSCompiler’s runtime library will provide standards-compliant polyfills where possible; nothing else may modify builtin objects
Do not add symbols to the global object unless absolutely necessary [e. g. required by a third-party API]
5. 11. 7 Omitting /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
201 when invoking a constructor
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
Never invoke a constructor in a
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
164 statement without using parentheses /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
201không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
15Use instead
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
16Omitting parentheses can lead to subtle mistakes. These two lines are not equivalent
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
176 Naming
6. 1 Rules common to all identifiers
Identifiers use only ASCII letters and digits, and, in a small number of cases noted below, underscores and very rarely [when required by frameworks like Angular] dollar signs
Give as descriptive a name as possible, within reason. Do not worry about saving horizontal space as it is far more important to make your code immediately understandable by a new reader. Do not use abbreviations that are ambiguous or unfamiliar to readers outside your project, and do not abbreviate by deleting letters within a word
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
18không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
196. 2 Rules by identifier type
6. 2. 1 Package names
Package names are all
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
501. For example, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
205, but not /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
206 or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
2076. 2. 2 Class names
Class, interface, record, and typedef names are written in
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
208. Unexported classes are simply locals. they are not marked /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
94 and therefore are not named with a trailing underscoreType names are typically nouns or noun phrases. For example,
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
210, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
211, or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
212. Additionally, interface names may sometimes be adjectives or adjective phrases instead [for example, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
213]6. 2. 3 Method names
Method names are written in
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
501. Names for /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
94 methods must end with a trailing underscoreMethod names are typically verbs or verb phrases. For example,
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
216 or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
217. Getter and setter methods for properties are never required, but if they are used they should be named /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
218 [or optionally /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
219 or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
220 for booleans], or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
221 for settersUnderscores may also appear in JsUnit test method names to separate logical components of the name. One typical pattern is
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
222, for example /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
223. There is no One Correct Way to name test methods6. 2. 4 Enum names
Enum names are written in
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
208, similar to classes, and should generally be singular nouns. Individual items within the enum are named in /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
2256. 2. 5 Constant names
Constant names use
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
225. all uppercase letters, with words separated by underscores. There is no reason for a constant to be named with a trailing underscore, since private static properties can be replaced by [implicitly private] module locals6. 2. 5. 1 Definition of “constant”Every constant is a
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
96 static property or a module-local /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
633 declaration, but not all /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
96 static properties and module-local /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
633s are constants. Before choosing constant case, consider whether the field really feels like a deeply immutable constant. For example, if any of that instance's observable state can change, it is almost certainly not a constant. Merely intending to never mutate the object is generally not enoughví dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
00Constants’ names are typically nouns or noun phrases
6. 2. 5. 2 Local aliasesLocal aliases should be used whenever they improve readability over fully-qualified names. Follow the same rules as
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74s [??], maintaining the last part of the aliased name. Aliases may also be used within functions. Aliases must be /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
633ví dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
016. 2. 6 Tên trường không cố định
Non-constant field names [static or otherwise] are written in
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
501, with a trailing underscore for private fieldsThese names are typically nouns or noun phrases. Ví dụ:
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
234 hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
2356. 2. 7 tên tham số
Tên tham số được viết bằng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
501. Lưu ý rằng điều này áp dụng ngay cả khi tham số mong đợi một hàm tạoOne-character parameter names should not be used in public methods
Exception. When required by a third-party framework, parameter names may begin with a
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
237. This exception does not apply to any other identifiers [e. g. local variables or properties]6. 2. 8 Local variable names
Local variable names are written in
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
501, except for module-local [top-level] constants, as described above. Constants in function scopes are still named in /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
501. Note that /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
501 is used even if the variable holds a constructor6. 2. 9 Template parameter names
Template parameter names should be concise, single-word or single-letter identifiers, and must be all-caps, such as
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
241 or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
2426. 2. 10 Module-local names
Module-local names that are not exported are implicitly private. They are not marked
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
94 and do not end in an underscore. This applies to classes, functions, variables, constants, enums, and other module-local identifiers6. 3 Camel case. defined
Sometimes there is more than one reasonable way to convert an English phrase into camel case, such as when acronyms or unusual constructs like IPv6 or iOS are present. To improve predictability, Google Style specifies the following [nearly] deterministic scheme
Beginning with the prose form of the name
- Convert the phrase to plain ASCII and remove any apostrophes. Ví dụ, thuật toán Müller có thể trở thành thuật toán Muellers
- Divide this result into words, splitting on spaces and any remaining punctuation [typically hyphens]
- Recommended. if any word already has a conventional camel case appearance in common usage, split this into its constituent parts [e. g. , AdWords becomes ad words]. Note that a word such as iOS is not really in camel case per se; it defies any convention, so this recommendation does not apply
- Now lowercase everything [including acronyms], then uppercase only the first character of
- … each word, to yield upper camel case, or
- … each word except the first, to yield lower camel case
- Finally, join all the words into a single identifier
Note that the casing of the original words is almost entirely disregarded
ví dụ
Prose formCorrectIncorrectXML HTTP requestXmlHttpRequestXMLHTTPRequestnew customer IDnewCustomerIdnewCustomerIDinner stopwatchinnerStopwatchinnerStopWatchsupports IPv6 on iOS?supportsIpv6OnIossupportsIPv6OnIOSYouTube importerYouTubeImporterYoutubeImporter**Acceptable, but not recommended
Note. Some words are ambiguously hyphenated in the English language. for example nonempty and non-empty are both correct, so the method names checkNonempty and checkNonEmpty are likewise both correct
7 JSDoc
JSDoc is used on all classes, fields, and methods
7. 1 General form
The basic formatting of JSDoc blocks is as seen in this example
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
02or in this single-line example
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
03If a single-line comment overflows into multiple lines, it must use the multi-line style with
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
244 and /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
245 on their own linesMany tools extract metadata from JSDoc comments to perform code validation and optimization. As such, these comments must be well-formed
7. 2 Markdown
JSDoc is written in Markdown, though it may include HTML when necessary
Note that tools that automatically extract JSDoc [e. g. JsDossier] will often ignore plain text formatting, so if you did this
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
04it would come out like this
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
05Instead, write a Markdown list
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
06Google style allows a subset of JSDoc tags. See ?? for the complete list. Most tags must occupy their own line, with the tag at the beginning of the line
không được phép
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
07Simple tags that do not require any additional data [such as
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
94, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
96, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
248, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
249] may be combined onto the same line, along with an optional type when appropriate/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
08There is no hard rule for when to combine tags, or in which order, but be consistent
For general information about annotating types in JavaScript see Annotating JavaScript for the Closure Compiler and Types in the Closure Type System
7. 4 Line wrapping
Line-wrapped block tags are indented four spaces. Wrapped description text may be lined up with the description on previous lines, but this horizontal alignment is discouraged
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
09Do not indent when wrapping a
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
250 or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
70 descriptionA file may have a top-level file overview. A copyright notice , author information, and default visibility level are optional. File overviews are generally recommended whenever a file consists of more than a single class definition. The top level comment is designed to orient readers unfamiliar with the code to what is in this file. If present, it may provide a description of the file's contents and any dependencies or compatibility information. Wrapped lines are not indented
Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
10Classes, interfaces and records must be documented with a description and any template parameters, implemented interfaces, visibility, or other appropriate tags. The class description should provide the reader with enough information to know how and when to use the class, as well as any additional considerations necessary to correctly use the class. Mô tả văn bản có thể được bỏ qua trên hàm tạo.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
252 and /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
588 annotations are not used with the /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
697 keyword unless the class is being used to declare an /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
105 or it extends a generic class/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
11Tất cả các enum và typedef phải được ghi lại bằng các thẻ JSDoc thích hợp [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
256 hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
673] ở dòng trước. Public enums and typedefs must also have a description. Individual enum items may be documented with a JSDoc comment on the preceding line/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
12Typedefs are useful for defining short record types, or aliases for unions, complex functions, or generic types. Typedefs should be avoided for record types with many fields, since they do not allow documenting individual fields, nor using templates or recursive references. For large record types, prefer
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
106In methods and named functions, parameter and return types must be documented, except in the case of same-signature
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
259s, where all types are omitted. The /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
666 type should be documented when necessary. Return type may be omitted if the function has no non-empty /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
621 statementsCác mô tả phương thức, tham số và trả về [nhưng không phải kiểu] có thể bị bỏ qua nếu chúng rõ ràng từ phần còn lại của JSDoc của phương thức hoặc từ chữ ký của nó
Mô tả phương thức bắt đầu bằng một cụm động từ mô tả chức năng của phương thức. Cụm từ này không phải là một câu mệnh lệnh, mà thay vào đó được viết ở ngôi thứ ba, như thể có một ngụ ý. trước nó
Nếu một phương thức ghi đè một phương thức của lớp bậc trên, nó phải bao gồm một chú thích
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
259. Các phương thức bị ghi đè kế thừa tất cả các chú thích JSDoc từ phương thức siêu hạng [bao gồm cả các chú thích khả năng hiển thị] và chúng nên được bỏ qua trong phương thức bị ghi đè. Tuy nhiên, nếu bất kỳ loại nào được tinh chỉnh trong chú thích loại, thì tất cả chú thích /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
263 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
264 phải được chỉ định rõ ràng/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
13Nếu bạn chỉ cần ghi lại thông số và kiểu trả về của hàm, bạn có thể tùy ý sử dụng JSDocs nội tuyến trong chữ ký của hàm. Các JSDoc nội tuyến này chỉ định các loại trả về và thông số không có thẻ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
14Nếu bạn cần mô tả hoặc thẻ, hãy sử dụng một nhận xét JSDoc duy nhất phía trên phương thức. Ví dụ: các phương thức trả về giá trị cần thẻ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
264/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
15/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
16Trong các chú thích chức năng ẩn danh thường là tùy chọn. Nếu suy luận loại tự động không đủ hoặc chú thích rõ ràng cải thiện khả năng đọc, thì hãy chú thích thông số và trả về các loại như thế này
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
17Đối với các biểu thức kiểu hàm, hãy xem ??
Các loại tài sản phải được ghi lại. Mô tả có thể được bỏ qua đối với các thuộc tính riêng tư, nếu tên và loại cung cấp đủ tài liệu để hiểu mã
Các hằng số được xuất công khai được nhận xét giống như các thuộc tính
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
187. 10 Loại chú thích
Chú thích loại được tìm thấy trên các thẻ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
263, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
264, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
182 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
269 và tùy chọn trên /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
96, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
249 và bất kỳ thẻ hiển thị nào. Các chú thích loại được đính kèm với các thẻ JSDoc phải luôn được đặt trong dấu ngoặc nhọn7. 10. 1 Nullability
Hệ thống loại xác định các công cụ sửa đổi lần lượt là
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
272 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
273 cho giá trị không null và nullable. Các công cụ sửa đổi này phải đứng trước loạiCông cụ sửa đổi tính vô hiệu có các yêu cầu khác nhau đối với các loại khác nhau, được chia thành hai loại chính
- Loại chú thích cho nguyên thủy [
274,/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
275,/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
276,/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
277,/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
645,/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
189] và chữ [/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
280 và/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
281] luôn không thể vô hiệu theo mặc định. Sử dụng công cụ sửa đổi/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
273 để biến nó thành null, nhưng bỏ qua phần dư thừa/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
272/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Các loại tham chiếu [nói chung, mọi thứ trong
208, bao gồm cả/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
285] đề cập đến một lớp, enum, bản ghi hoặc typedef được xác định ở nơi khác. Since these types may or may not be nullable, it is impossible to tell from the name alone whether it is nullable or not. Always use explicit/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
273 and/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
272 modifiers for these types to prevent ambiguity at use sites/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
Bad
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
19Good
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
207. 10. 2 Type Casts
In cases where the compiler doesn't accurately infer the type of an expression, and the assertion functions in goog. asserts cannot remedy it , it is possible to tighten the type by adding a type annotation comment and enclosing the expression in parentheses. Note that the parentheses are required
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
217. 10. 3 Template Parameter Types
Always specify template parameters. This way compiler can do a better job and it makes it easier for readers to understand what code does
Bad
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
22Good
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
23Cases when template parameters should not be used
650 is used for type hierarchy and not as map-like structure/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
7. 10. 4 Function type expressions
Terminology Note. function type expression refers to a type annotation for function types with the keyword
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
601 in the annotation [see examples below]Where the function definition is given, do not use a function type expression. Specify parameter and return types with
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
263 and /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
264, or with inline annotations [see ??]. This includes anonymous functions and functions defined and assigned to a const [where the function jsdoc appears above the whole assignment expression]Function type expressions are needed, for example, inside
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
256, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
263 or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
264. Use it also for variables or properties of function type, if they are not immediately initialized with the function definition/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
24When using a function type expression, always specify the return type explicitly. Otherwise the default return type is unknown [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
273], which leads to strange and unexpected behavior, and is rarely what is actually desiredBad - type error, but no warning given
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
25Good
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
267. 10. 5 Whitespace
Within a type annotation, a single space or line break is required after each comma or colon. Các ngắt dòng bổ sung có thể được chèn vào để cải thiện khả năng đọc hoặc tránh vượt quá giới hạn cột. These breaks should be chosen and indented following the applicable guidelines [e. g. ?? and ??]. No other whitespace is allowed in type annotations
Good
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
27Bad
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
287. 11 Visibility annotations
Visibility annotations [
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
94, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
679, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
678] may be specified in a /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
70 block, or on any exported symbol or property. Do not specify visibility for local variables, whether within a function or at the top level of a module. All /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
94 names must end with an underscore8 Policies
8. 1 Issues unspecified by Google Style. Be Consistent
For any style question that isn't settled definitively by this specification, prefer to do what the other code in the same file is already doing. If that doesn't resolve the question, consider emulating the other files in the same package
8. 2 Compiler warnings
8. 2. 1 Use a standard warning set
As far as possible projects should use
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
3018. 2. 2 How to handle a warning
Before doing anything, make sure you understand exactly what the warning is telling you. If you're not positive why a warning is appearing, ask for help
Once you understand the warning, attempt the following solutions in order
- First, fix it or work around it. Make a strong attempt to actually address the warning, or find another way to accomplish the task that avoids the situation entirely
- Otherwise, determine if it's a false alarm. If you are convinced that the warning is invalid and that the code is actually safe and correct, add a comment to convince the reader of this fact and apply the
302 annotation/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Otherwise, leave a TODO comment. Đây là một phương sách cuối cùng. If you do this, do not suppress the warning. The warning should be visible until it can be taken care of properly
8. 2. 3 Loại bỏ cảnh báo ở phạm vi hợp lý hẹp nhất
Warnings are suppressed at the narrowest reasonable scope, usually that of a single local variable or very small method. Often a variable or method is extracted for that reason alone
Thí dụ
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
29Ngay cả một số lượng lớn các biện pháp ngăn chặn trong một lớp vẫn tốt hơn là làm mù cả lớp trước kiểu cảnh báo này
Đánh dấu các phương thức, lớp hoặc giao diện không dùng nữa bằng chú thích
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
303. Nhận xét không dùng nữa phải bao gồm hướng dẫn đơn giản, rõ ràng để mọi người khắc phục trang web cuộc gọi của họ8. 4 Mã không có trong Google Style
Đôi khi, bạn sẽ gặp phải các tệp trong cơ sở mã của mình không đúng với Google Style. Những điều này có thể đến từ việc mua lại hoặc có thể đã được viết trước khi Google Style đưa ra quan điểm về một số vấn đề hoặc có thể không thuộc Google Style vì bất kỳ lý do nào khác
8. 4. 1 Định dạng lại mã hiện có
When updating the style of existing code, follow these guidelines
- Không bắt buộc phải thay đổi tất cả mã hiện có để đáp ứng các nguyên tắc về kiểu dáng hiện tại. Reformatting existing code is a trade-off between code churn and consistency. Style rules evolve over time and these kinds of tweaks to maintain compliance would create unnecessary churn. However, if significant changes are being made to a file it is expected that the file will be in Google Style
- Hãy cẩn thận để không cho phép các sửa đổi phong cách cơ hội làm xáo trộn trọng tâm của CL. Nếu bạn thấy mình thực hiện nhiều thay đổi về phong cách không quan trọng đối với trọng tâm của CL, hãy thúc đẩy những thay đổi đó thành một CL riêng
8. 4. 2 Newly added code. use Google Style
Brand new files use Google Style, regardless of the style choices of other files in the same package
When adding new code to a file that is not in Google Style, reformatting the existing code first is recommended, subject to the advice in ??
If this reformatting is not done, then new code should be as consistent as possible with existing code in the same file, but must not violate the style guide
8. 5 Local style rules
Teams and projects may adopt additional style rules beyond those in this document, but must accept that cleanup changes may not abide by these additional rules, and must not block such cleanup changes due to violating any additional rules. Beware of excessive rules which serve no purpose. The style guide does not seek to define style in every possible scenario and neither should you
8. 6 Generated code. mostly exempt
Source code generated by the build process is not required to be in Google Style. However, any generated identifiers that will be referenced from hand-written source code must follow the naming requirements. As a special exception, such identifiers are allowed to contain underscores, which may help to avoid conflicts with hand-written identifiers
9 Appendices
9. 1 JSDoc tag reference
JSDoc serves multiple purposes in JavaScript. In addition to being used to generate documentation it is also used to control tooling. The best known are the Closure Compiler type annotations
9. 1. 1 Type annotations and other Closure Compiler annotations
Documentation for JSDoc used by the Closure Compiler is described in Annotating JavaScript for the Closure Compiler and Types in the Closure Type System
9. 1. 2 Documentation annotations
In addition to the JSDoc described in Annotating JavaScript for the Closure Compiler the following tags are common and well supported by various documentation generation tools [such as JsDossier] for purely documentation purposes
You may also see other types of JSDoc annotations in third-party code. These annotations appear in the JSDoc Toolkit Tag Reference but are not considered part of valid Google style
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
304 or /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
305 - Not recommendedNot recommended
Syntax.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
306/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
30Tài liệu về tác giả của tệp hoặc chủ sở hữu của bài kiểm tra, thường chỉ được sử dụng trong nhận xét
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
70. Thẻ /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
305 được bảng điều khiển kiểm tra đơn vị sử dụng để xác định ai sở hữu kết quả kiểm tra/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
309cú pháp.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
310/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
31Cho biết những lỗi mà chức năng kiểm tra đã cho kiểm tra hồi quy
Mỗi lỗi nên có dòng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
309 riêng để giúp tìm kiếm các bài kiểm tra hồi quy dễ dàng nhất có thể/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
312 - Không dùng nữa. Không được dùngkhông dùng nữa. Không được dùng. Use Markdown backticks instead
Syntax.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
313Trong lịch sử,
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
314 được viết là /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
315/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
32Indicates that a term in a JSDoc description is code so it may be correctly formatted in generated documentation
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
250Syntax.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
317/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
33/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
318Syntax.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
319This tag is used to generate cross-reference links within generated documentation
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
34Historical note. @link tags have also been used to create external links in generated documentation. For external links, always use Markdown's link syntax instead
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
35/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
320Syntax.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
321/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
36Reference a lookup to another class function or method
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
322Syntax.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
323/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
37Used in a fileoverview to indicate what browsers are supported by the file
9. 1. 3 Framework specific annotations
The following annotations are specific to a particular framework
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
324 for Angular 1/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
325 for Polymerhttps. //github. com/google/closure-compiler/wiki/Polymer-Pass
9. 1. 4 Notes about standard Closure Compiler annotations
The following tags used to be standard but are now deprecated
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
326 - Deprecated. Do not useDeprecated. Do not use. Sử dụng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
249 và/hoặc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
687 để thay thế/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
329 - Không dùng nữa. Do not useDeprecated. Do not use. Use
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
259 instead9. 2 Commonly misunderstood style rules
Here is a collection of lesser-known or commonly misunderstood facts about Google Style for JavaScript. [The following are true statements; this is not a list of myths. ]
- Neither a copyright statement nor
304 credit is required in a source file. [Neither is explicitly recommended, either. ]/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- There is no hard and fast rule governing how to order the members of a class [??]
- Empty blocks can usually be represented concisely as
581, as detailed in [??]/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- The prime directive of line-wrapping is. prefer to break at a higher syntactic level [??]
- Non-ASCII characters are allowed in string literals, comments and JSDoc, and in fact are recommended when they make the code easier to read than the equivalent Unicode escape would [??]
The following tools exist to support various aspects of Google Style
9. 3. 1 Closure Compiler
This program performs type checking and other checks, optimizations and other transformations [such as ECMAScript 6 to ECMAScript 5 code lowering]
9. 3. 2 /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
571
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
This program reformats JavaScript source code into Google Style, and also follows a number of non-required but frequently readability-enhancing formatting practices. The output produced by
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
571 is compliant with the style guide/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
571 không bắt buộc. Các tác giả được phép thay đổi đầu ra của nó và người đánh giá được phép yêu cầu những thay đổi đó; . However, subtrees may choose to opt in to such enforcement locally9. 3. 3 Đóng trình biên dịch linter
Chương trình này kiểm tra một loạt các bước sai và chống mẫu
9. 3. 4 Conformance framework
The JS Conformance Framework is a tool that is part of the Closure Compiler that provides developers a simple means to specify a set of additional checks to be run against their code base above the standard checks. Conformance checks can, for example, forbid access to a certain property, or calls to a certain function, or missing type information [unknowns]
These rules are commonly used to enforce critical restrictions [such as defining globals, which could break the codebase] and security patterns [such as using
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
184 or assigning to /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
337], or more loosely to improve code qualityFor additional information see the official documentation for the JS Conformance Framework
9. 4 Exceptions for legacy platforms
9. 4. 1 Overview
Phần này mô tả các ngoại lệ và quy tắc bổ sung cần tuân theo khi cú pháp ECMAScript 6 hiện đại không có sẵn cho tác giả mã. Các ngoại lệ đối với kiểu được đề xuất là bắt buộc khi không thể sử dụng cú pháp ECMAScript 6 và được nêu tại đây
- Cho phép sử dụng khai báo
637/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Cho phép sử dụng
131/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Cho phép tham số tùy chọn không có giá trị mặc định
9. 4. 2 Sử dụng /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
637
9. 4. 2. 1 khai báo /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
637 KHÔNG có phạm vi khốiCác khai báo
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
637 nằm trong phạm vi bắt đầu của hàm, tập lệnh hoặc mô-đun kèm theo gần nhất, điều này có thể gây ra hành vi không mong muốn, đặc biệt là với các lần đóng hàm tham chiếu các khai báo /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
637 bên trong các vòng lặp. Đoạn mã sau đưa ra một ví dụ/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
389. 4. 2. 2 Khai báo các biến càng gần với lần sử dụng đầu tiên càng tốtMặc dù các khai báo
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
637 nằm trong phạm vi bắt đầu của hàm kèm theo, các khai báo /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
637 phải càng gần càng tốt với lần sử dụng đầu tiên của chúng, vì mục đích dễ đọc. Tuy nhiên, không đặt khai báo /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
637 bên trong khối nếu biến đó được tham chiếu bên ngoài khối. Ví dụ/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
399. 4. 2. 3 Sử dụng @const cho các biến hằngĐối với các khai báo toàn cầu nơi từ khóa
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
633 sẽ được sử dụng, nếu có, hãy chú thích khai báo /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
637 bằng @const thay thế [đây là tùy chọn cho các biến cục bộ]9. 4. 3 Không sử dụng khai báo hàm phạm vi khối
Đừng làm điều này
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
40Mặc dù hầu hết các máy ảo JavaScript được triển khai trước khi ECMAScript 6 hỗ trợ khai báo hàm trong các khối nhưng nó không được chuẩn hóa. Việc triển khai không nhất quán với nhau và với hành vi ECMAScript 6 tiêu chuẩn hiện nay để khai báo hàm trong phạm vi khối. ECMAScript 5 trở về trước chỉ cho phép khai báo hàm trong danh sách câu lệnh gốc của tập lệnh hoặc hàm và cấm rõ ràng chúng trong phạm vi khối ở chế độ nghiêm ngặt
Để có được hành vi nhất quán, thay vào đó, hãy sử dụng một
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
637 được khởi tạo với một biểu thức hàm để xác định một hàm trong một khối/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
419. 4. 4 Quản lý phụ thuộc với /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
518//* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74
9. 4. 4. 1. Tóm tắt/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
CẢNH BÁO. Quản lý phụ thuộc
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
518 không được dùng nữa. Tất cả các tệp mới, ngay cả trong các dự án sử dụng /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
518 cho các tệp cũ hơn, nên sử dụng /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
66. Các quy tắc sau đây chỉ dành cho các tệp /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
518 có sẵn- Đặt tất cả các
518 trước,/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
74 thứ hai. Tách cung cấp khỏi yêu cầu bằng một dòng trống/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Sắp xếp các mục theo thứ tự bảng chữ cái [viết hoa trước]
- Không bọc các câu lệnh
518 và/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
74. Vượt quá 80 cột nếu cần/* Poor: the reader has no idea what character this is. */ const units = '\u03bcs';
- Chỉ cung cấp các biểu tượng cấp cao nhất
Các câu lệnh
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
518 nên được nhóm lại với nhau và đặt trước. Tất cả các câu lệnh /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 phải tuân theo. Hai danh sách phải được phân tách bằng một dòng trốngTương tự như câu lệnh nhập bằng các ngôn ngữ khác, câu lệnh
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
518 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 phải được viết trên một dòng, ngay cả khi chúng vượt quá giới hạn độ dài dòng 80 cộtCác dòng nên được sắp xếp theo thứ tự bảng chữ cái, với các chữ hoa đến trước
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
42Tất cả các thành viên được xác định trên một lớp phải ở trong cùng một tệp. Chỉ nên cung cấp các lớp cấp cao nhất trong một tệp chứa nhiều thành viên được định nghĩa trên cùng một lớp [e. g. enums, các lớp bên trong, v.v.]
Làm cái này
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
43Không phải cái này
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
44Thành viên trên không gian tên cũng có thể được cung cấp
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
459. 4. 4. 2 Bí danh với /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
364CẢNH BÁO.
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
364 không được dùng nữa. Các tệp mới không nên sử dụng /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
364 ngay cả trong các dự án có sử dụng /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
364 hiện có/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
364 có thể được sử dụng để rút ngắn các tham chiếu đến các ký hiệu được đặt tên trong mã bằng cách sử dụng quản lý phụ thuộc /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
518//* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74Chỉ có thể thêm một lệnh gọi
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
364 cho mỗi tệp. Luôn đặt nó trong phạm vi toàn cầuLời gọi
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
372 mở đầu phải được đặt trước chính xác một dòng trống và theo sau mọi câu lệnh /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
518, câu lệnh /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 hoặc nhận xét cấp cao nhất. Lệnh gọi phải được đóng ở dòng cuối cùng trong tệp. Nối /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
375 vào câu lệnh kết thúc của phạm vi. Tách nhận xét khỏi dấu chấm phẩy bằng hai dấu cáchSimilar to C++ namespaces, do not indent under
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
364 declarations. Thay vào đó, hãy tiếp tục từ cột 0Only make aliases for names that will not be re-assigned to another object [e. g. , hầu hết các hàm tạo, enum và không gian tên]. Đừng làm điều này [xem bên dưới để biết cách đặt bí danh cho hàm tạo]
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
46Tên phải giống với thuộc tính cuối cùng của toàn cầu mà chúng đang đặt bí danh
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
479. 4. 4. 3 /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
525Thích sử dụng
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75 thay vì /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
525 để phá vỡ sự phụ thuộc vòng tròn giữa các tệp trong cùng một thư viện. Không giống như /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74, một câu lệnh /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75 được phép nhập một không gian tên trước khi nó được xác định/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
525 vẫn có thể được sử dụng trong mã kế thừa để phá vỡ các tham chiếu vòng tròn trải dài qua các ranh giới thư viện, nhưng mã mới hơn nên được cấu trúc để tránh điều đóCác câu lệnh của
/* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
525 phải tuân theo các quy tắc về kiểu dáng giống như /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75. Toàn bộ khối câu lệnh /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
525, /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
74 và /* Poor: the reader has no idea what character this is. */
const units = '\u03bcs';
75 được sắp xếp theo thứ tự bảng chữ cái