Quy ước đặt tên cho hàm trong javascript

“Chỉ có hai điều khó khăn trong Khoa học Máy tính. vô hiệu hóa bộ đệm và đặt tên mọi thứ” - Phil Karlton

TL; DR

  • Tên biến luôn là trường hợp lạc đà và nên bắt đầu bằng một danh từ;
  • Tên chức năng nên bắt đầu bằng một động từ
  • Đặt tên biến càng ngắn càng tốt
  • Tên biến gồm một ký tự như
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    11,
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    12,
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    13 thường được dành riêng để sử dụng trong các vòng lặp
  • Tên vô nghĩa cũng nên tránh, chẳng hạn như
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    14,
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    15
  • Để xác định một biến không đổi, hãy nhớ sử dụng tất cả các chữ cái viết hoa với dấu gạch dưới để phân tách các từ

Tôi đã làm việc với C# và JavaScript trong vài năm qua và nhận ra rằng mỗi ngôn ngữ dường như có một bộ quy ước đặt tên riêng. Tôi muốn chia sẻ với bạn một số quy ước đặt tên cho JavaScript mà cá nhân tôi thích hơn

Hầu hết mã bạn viết liên quan đến các biến và hàm, vì vậy việc xác định cách đặt tên cho những mã đó là rất quan trọng đối với mã toàn diện. Cốt lõi của JavaScript, ECMAScript, được viết bằng cách sử dụng một quy ước gọi là trường hợp lạc đà. Về cơ bản, tên của nó bắt đầu bằng một chữ cái viết thường và mỗi từ tiếp theo phụ bắt đầu bằng một chữ cái viết hoa. e. g

var theName
var anotherVariable

Camel-case cũng là biến và chức năng được nhiều nhà phát triển JavaScript đặt tên nhất

Bạn có thể nghe nói về ký hiệu tiếng Hungary đã phổ biến cho JavaScript vài năm trước. Nó liên quan đến việc đặt trước một mã định danh loại biến ở đầu tên

Biến và hàm

Tên biến luôn viết hoa thường và phải bắt đầu bằng danh từ để phân biệt biến với hàm, danh từ này thường bắt đầu bằng động từ

Nhưng đối với biến boolean, tôi sẽ tạo một ngoại lệ, thường tôi đặt tên chúng là

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
16, nó giống với tên hàm trả về boolean

Nói chung, bạn nên cố gắng đặt tên biến càng ngắn càng tốt. Cố gắng làm cho tên biến chỉ ra kiểu dữ liệu của giá trị của nó. Ví dụ:

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
17,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
0,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
1 đề xuất kiểu dữ liệu là số.
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
2,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
3 nghe như chuỗi. Tên biến gồm một ký tự như
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
11,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
12,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
13 thường được dành riêng để sử dụng trong các vòng lặp

Tên vô nghĩa cũng nên tránh, chẳng hạn như

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
14,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
15

Đối với tên hàm và phương thức, từ đầu tiên phải luôn là một động từ và có một số quy ước chung được sử dụng như được mô tả trong bảng bên dưới

VerbMeaningcan/ has/ isFunction trả về một booleangetFunction trả về một non-booleansetFunction để lưu một giá trị

hằng số

Để phân biệt biến thường (có giá trị thay đổi) và hằng (được khởi tạo thành giá trị và không bao giờ thay đổi), tôi thường sử dụng tất cả các chữ cái viết hoa với dấu gạch dưới để phân tách các từ.

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'

Ví dụ

Điều này cũng áp dụng cho TS

private _newString: string
public newVar: string
public user$: Observable
public isUserTokenValid: boolean
public canPerformAction: boolean
public ids: string[]
public id: string;
readonly ONE_MINUTE_IN_MILLISECONDS = 60 * 1000;
public filterUsers(): void {}
public setUser(user: User): void{}

Gần đây, tôi đã đọc hướng dẫn tuyệt vời này. Đó là tất cả về cách viết mã Javascript sạch. Các bạn có thể kiểm tra nó ở liên kết dưới đây

Các hướng dẫn sau bao gồm viết mã ví dụ JavaScript cho MDN Web Docs. Bài viết này là một danh sách các quy tắc để viết các ví dụ ngắn gọn mà càng nhiều người có thể hiểu được càng tốt

Phần này giải thích các nguyên tắc chung cần ghi nhớ khi viết các ví dụ về mã JavaScript. Các phần sau sẽ trình bày chi tiết cụ thể hơn

Ý kiến ​​về cách thụt đầu dòng, khoảng trắng và độ dài dòng chính xác luôn gây tranh cãi. Các cuộc thảo luận về các chủ đề này làm sao nhãng việc tạo và duy trì nội dung

Trên MDN Web Docs, chúng tôi sử dụng Prettier làm trình định dạng mã để giữ cho kiểu mã nhất quán (và để tránh các cuộc thảo luận lạc đề). Bạn có thể tham khảo tệp cấu hình của chúng tôi để tìm hiểu về các quy tắc hiện tại và đọc tài liệu của Prettier

Định dạng đẹp hơn tất cả mã và giữ phong cách nhất quán. Tuy nhiên, có một vài quy tắc bổ sung mà bạn cần tuân theo

Bạn có thể sử dụng các tính năng mới sau khi mọi trình duyệt chính — Chrome, Edge, Firefox và Safari — hỗ trợ chúng

Đánh dấu thụt đầu dòng với 2 dấu cách. Không sử dụng ký tự tab. Ký tự cuối dòng là

closeConnection();
5, quy ước Unix. Để giúp bạn, chúng tôi đã đưa tệp
closeConnection();
6 vào kho lưu trữ. Nhiều biên tập viên đọc nội dung của nó và sử dụng nó để định cấu hình hành vi của họ

Để tạo mảng, hãy sử dụng chữ chứ không phải hàm tạo

Tạo các mảng như thế này

const visitedCities = [];

Đừng làm điều này trong khi tạo mảng

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
0

Khi thêm các mục vào một mảng, hãy sử dụng

closeConnection();
7 và không gán trực tiếp. Xét mảng sau

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
2

Thêm các mục vào mảng như thế này

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
3

Đừng thêm các mục vào mảng như thế này

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
4

Viết mã không đồng bộ cải thiện hiệu suất và nên được sử dụng khi có thể. Đặc biệt, bạn có thể sử dụng

  • lời hứa
  • closeConnection();
    
    8/
    closeConnection();
    
    9

Khi có thể sử dụng cả hai kỹ thuật, chúng tôi thích sử dụng cú pháp

closeConnection();
8/
closeConnection();
9 đơn giản hơn. Thật không may, bạn không thể sử dụng
closeConnection();
9 ở cấp cao nhất trừ khi bạn đang ở trong mô-đun ECMAScript. Các mô-đun CommonJS được sử dụng bởi Node. js không phải là mô-đun ES. Nếu ví dụ của bạn dự định sẽ được sử dụng ở mọi nơi, hãy tránh
closeConnection();
9 cấp cao nhất

Nhận xét rất quan trọng để viết các ví dụ mã tốt. Họ làm rõ mục đích của mã và giúp các nhà phát triển hiểu nó. Đặc biệt chú ý đến họ

  • Nếu mục đích hoặc logic của mã không rõ ràng, hãy thêm nhận xét về ý định của bạn, như minh họa bên dưới

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    1

    Mặt khác, viết lại mã bằng văn xuôi không phải là cách sử dụng tốt các nhận xét

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    2

  • Nhận xét cũng không cần thiết khi các hàm có tên rõ ràng mô tả những gì chúng đang làm. Viết

    closeConnection();
    

    đừng viết

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    4

Nhận xét một dòng được đánh dấu bằng

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
44, trái ngược với nhận xét khối được đặt giữa
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
45

Nói chung, hãy sử dụng chú thích một dòng để chú thích mã. Người viết phải đánh dấu từng dòng của nhận xét bằng

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
44, để dễ dàng nhận thấy mã được nhận xét một cách trực quan hơn. Ngoài ra, quy ước này cho phép nhận xét các phần mã bằng cách sử dụng
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
45 trong khi gỡ lỗi

  • Để lại một khoảng cách giữa các dấu gạch chéo và nhận xét. Bắt đầu bằng một chữ in hoa, giống như một câu, nhưng không kết thúc nhận xét bằng dấu chấm

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    9

  • Nếu nhận xét không bắt đầu ngay sau mức thụt đầu dòng mới, hãy thêm một dòng trống rồi thêm nhận xét. Nó sẽ tạo ra một khối mã, làm cho nó rõ ràng những gì nhận xét đề cập đến. Ngoài ra, hãy đặt nhận xét của bạn trên các dòng riêng biệt trước mã mà họ đang đề cập đến. Điều này được thể hiện trong ví dụ sau

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    00

  • Trong mã dự định chạy trong môi trường sản xuất, bạn hiếm khi cần nhận xét khi ghi nhật ký một số dữ liệu. Trong các ví dụ mã, chúng tôi thường sử dụng các hàm
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    48,
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    49 hoặc tương tự để xuất các giá trị quan trọng. Để giúp người đọc hiểu điều gì sẽ xảy ra mà không cần chạy mã, bạn có thể đặt nhận xét sau hàm với nhật ký sẽ được tạo. Viết

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    01

    đừng viết

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    02

  • Trong trường hợp dòng quá dài, hãy đặt nhận xét sau chức năng, như thế này

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    03

Nhận xét ngắn thường tốt hơn, vì vậy hãy cố gắng giữ chúng trong một dòng gồm 60–80 ký tự. Nếu không được, hãy sử dụng

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
44 ở đầu mỗi dòng

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
04

Không sử dụng

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
45

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
05

Bỏ qua mã dự phòng bằng cách sử dụng dấu chấm lửng (...) là cần thiết để giữ cho các ví dụ ngắn gọn. Tuy nhiên, người viết nên làm điều đó một cách cẩn thận vì các nhà phát triển thường xuyên sao chép và dán các ví dụ vào mã của họ và tất cả các mẫu mã của chúng tôi phải là JavaScript hợp lệ

Trong JavaScript, bạn nên đặt dấu chấm lửng (

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
92) trong nhận xét. Khi có thể, hãy cho biết hành động mà ai đó sử dụng lại đoạn mã này dự kiến ​​sẽ thêm vào

Sử dụng nhận xét cho dấu chấm lửng (…) rõ ràng hơn, ngăn ngừa lỗi khi nhà phát triển sao chép và dán mã mẫu. Viết

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
06

Đừng sử dụng dấu chấm lửng (...) như thế này

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
07

Khi viết code, bạn thường bỏ qua các tham số không cần thiết. Nhưng trong một số ví dụ mã, bạn muốn chứng minh rằng bạn đã không sử dụng một số tham số có thể

Để làm như vậy, hãy sử dụng

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
45 trong danh sách tham số. Đây là một ngoại lệ đối với quy tắc chỉ sử dụng nhận xét một dòng (
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
44)

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
08

Đối với tên hàm, hãy sử dụng camelCase, bắt đầu bằng ký tự chữ thường. Sử dụng tên ngắn gọn, dễ đọc và có ngữ nghĩa khi thích hợp

Sau đây là một ví dụ đúng về tên hàm

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
09

Không sử dụng tên chức năng như thế này

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
20

  • Nếu có thể, hãy sử dụng khai báo hàm trên biểu thức hàm để xác định hàm. Đây là cách được khuyến nghị để khai báo một hàm

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    21

    Đây không phải là một cách tốt để xác định một chức năng

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    22

  • Khi sử dụng các hàm ẩn danh làm hàm gọi lại (một hàm được truyền cho lời gọi phương thức khác), nếu bạn không cần truy cập
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    95, hãy sử dụng hàm mũi tên để làm cho mã ngắn hơn và sạch hơn. Đây là cách được đề xuất

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    23

    thay vì điều này

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    24

  • Cân nhắc tránh sử dụng chức năng mũi tên để gán chức năng cho một mã định danh. Đặc biệt, không sử dụng các hàm mũi tên cho các phương thức. Sử dụng khai báo hàm với từ khóa
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    96

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    25

    đừng làm

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    26

  • Khi sử dụng các chức năng mũi tên, hãy sử dụng (còn được gọi là phần thân ngắn gọn) khi có thể

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    27

    Và không

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    28

Khi cần có vòng lặp, hãy chọn vòng lặp thích hợp từ

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
97,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
98,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
99, v.v.

  • Khi lặp qua tất cả các phần tử của bộ sưu tập, hãy tránh sử dụng vòng lặp cổ điển
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    000; . Lưu ý rằng nếu bạn đang sử dụng một bộ sưu tập không phải là
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    003, bạn phải kiểm tra xem
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    98 có thực sự được hỗ trợ hay không (nó yêu cầu biến có thể lặp lại) hoặc phương thức
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    002 có thực sự tồn tại hay không. Sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    98

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    29

    Hoặc
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    002

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    30

    Không sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    000 — bạn không chỉ phải thêm một chỉ mục bổ sung,
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    009 mà còn phải theo dõi độ dài của mảng. Điều này có thể dễ bị lỗi cho người mới bắt đầu

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    31

  • Đảm bảo rằng bạn xác định đúng trình khởi tạo bằng cách sử dụng từ khóa
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    010 cho
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    98 hoặc
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    012 cho các vòng lặp khác. Đừng bỏ qua nó. Đây là những ví dụ đúng

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    32

    Ví dụ dưới đây không tuân theo các nguyên tắc khởi tạo được đề xuất (nó ngầm tạo một biến toàn cục và sẽ không thành công ở chế độ nghiêm ngặt)

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    33

  • Khi bạn cần truy cập cả giá trị và chỉ mục, bạn có thể sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    013 thay vì
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    000. Viết

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    34

    Đừng viết

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    35

Cảnh báo. Không bao giờ sử dụng

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
015 với mảng và chuỗi

Ghi chú. Cân nhắc hoàn toàn không sử dụng vòng lặp

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
016. Nếu bạn đang sử dụng
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
003 (hoặc
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
018 cho một số thao tác), thay vào đó, hãy cân nhắc sử dụng các phương pháp lặp ngữ nghĩa hơn, chẳng hạn như
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
019,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
020,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
021,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
022,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
023, v.v.

Có một trường hợp đáng chú ý cần lưu ý đối với các câu lệnh kiểm soát

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
024. Nếu câu lệnh
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
025 kết thúc bằng
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
026, không thêm câu lệnh
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
027

Tiếp tục ngay sau câu lệnh

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
025. Viết

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
36

Đừng viết

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
37

Mặc dù các câu lệnh luồng điều khiển như

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
025,
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
016 và
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
99 không yêu cầu sử dụng dấu ngoặc nhọn khi nội dung được tạo từ một câu lệnh duy nhất, bạn nên luôn sử dụng dấu ngoặc nhọn. Viết

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
38

đừng viết

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
39

Điều này ngăn việc quên thêm dấu ngoặc khi thêm nhiều câu lệnh

Báo cáo chuyển đổi có thể là một chút khó khăn

  • Không thêm câu lệnh
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    032 sau câu lệnh
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    026 trong trường hợp cụ thể. Thay vào đó, hãy viết các câu lệnh
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    026 như thế này

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    40

    Nếu bạn thêm một câu lệnh
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    032, nó sẽ không thể truy cập được. Đừng viết

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    41

  • Sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    036 làm trường hợp cuối cùng và không kết thúc bằng câu lệnh
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    032. Nếu bạn cần làm khác đi, hãy thêm nhận xét giải thích lý do tại sao
  • Hãy nhớ rằng khi bạn khai báo một biến cục bộ cho một trường hợp, bạn cần sử dụng dấu ngoặc nhọn để xác định phạm vi

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    42

  • Nếu một số trạng thái nhất định trong chương trình của bạn gây ra lỗi chưa được phát hiện, chúng sẽ tạm dừng thực thi và có khả năng làm giảm tính hữu dụng của ví dụ. Do đó, bạn nên bắt lỗi bằng cách sử dụng khối
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    038, như được hiển thị bên dưới

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    43

  • Khi không cần tham số của câu lệnh
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    039 thì bỏ qua

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    44

Ghi chú. Hãy nhớ rằng chỉ những lỗi có thể phục hồi mới được bắt và xử lý. Tất cả các lỗi không thể khôi phục phải được thông qua và tạo bọt cho ngăn xếp cuộc gọi

  • Khi định nghĩa một lớp, hãy sử dụng PascalCase (bắt đầu bằng chữ hoa) cho tên lớp và camelCase (bắt đầu bằng chữ thường) cho thuộc tính đối tượng và tên phương thức
  • Khi xác định một thể hiện đối tượng, bằng chữ hoặc thông qua hàm tạo, hãy sử dụng camelCase, bắt đầu bằng ký tự viết thường, cho tên thể hiện. Ví dụ

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    45

Để tạo các đối tượng chung (i. e. , khi các lớp không liên quan), hãy sử dụng chữ chứ không phải hàm tạo

Ví dụ, làm điều này

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
46

Đừng tạo một đối tượng chung chung như thế này

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
47

  • Sử dụng cú pháp lớp ES cho các đối tượng, không phải các hàm tạo kiểu cũ. Ví dụ: đây là cách được đề xuất

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    48

  • Sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    040 để thừa kế

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    49

Để định nghĩa các phương thức, hãy sử dụng cú pháp định nghĩa phương thức

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
10

Thay vì

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
11

  • Phương pháp
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    041 không được dùng nữa để thay thế bằng phương pháp
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    042
  • Khi có thể, hãy sử dụng tốc ký để tránh trùng lặp định danh thuộc tính. Viết

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    12

    đừng viết

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    13

Phần này liệt kê các đề xuất của chúng tôi về việc nên sử dụng toán tử nào và khi nào

Khi bạn muốn lưu trữ vào một biến một giá trị bằng chữ tùy thuộc vào một điều kiện, hãy sử dụng toán tử điều kiện (bộ ba) thay vì câu lệnh

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
024. Quy tắc này cũng áp dụng khi trả về một giá trị. Viết

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
14

Đừng viết

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
15

Toán tử điều kiện rất hữu ích khi tạo chuỗi để ghi thông tin. Trong những trường hợp như vậy, việc sử dụng câu lệnh

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
024 thông thường dẫn đến các khối mã dài cho hoạt động phụ như ghi nhật ký, làm xáo trộn điểm trung tâm của ví dụ

Ưu tiên các toán tử đẳng thức nghiêm ngặt (bằng ba) và bất đẳng thức hơn các toán tử đẳng thức lỏng lẻo (bằng kép) và bất đẳng thức

Sử dụng các toán tử đẳng thức và bất đẳng thức nghiêm ngặt như thế này

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
16

Không sử dụng các toán tử đẳng thức và bất đẳng thức lỏng lẻo, như hình bên dưới

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
17

Nếu bạn cần sử dụng

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
045 hoặc
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
046, hãy nhớ rằng
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
047 là trường hợp duy nhất được chấp nhận. Vì TypeScript sẽ không thành công trong tất cả các trường hợp khác, chúng tôi không muốn có chúng trong mã ví dụ của mình. Cân nhắc thêm một nhận xét để giải thích lý do tại sao bạn cần nó

Thích các phím tắt cho các bài kiểm tra boolean. Ví dụ: sử dụng

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
048 và
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
049, không phải
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
050 và
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
051, trừ khi các loại giá trị trung thực hoặc giả khác nhau được xử lý khác nhau

Chuỗi ký tự có thể được đặt trong dấu nháy đơn, như trong

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
052, hoặc trong dấu ngoặc kép, như trong
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
053. Đừng lo lắng về việc sử dụng cái nào;

Để chèn giá trị vào chuỗi, hãy sử dụng chữ mẫu

  • Dưới đây là một ví dụ về cách được đề xuất để sử dụng chữ mẫu. Việc sử dụng chúng ngăn ngừa rất nhiều lỗi về khoảng cách

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    18

    Đừng nối các chuỗi như thế này

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    19

  • Đừng lạm dụng chữ mẫu. Nếu không có thay thế, thay vào đó hãy sử dụng một chuỗi ký tự bình thường

Tên biến tốt là điều cần thiết để hiểu mã

  • Sử dụng các mã định danh ngắn và tránh các từ viết tắt không phổ biến. Tên biến tốt thường dài từ 3 đến 10 ký tự, nhưng chỉ để gợi ý. Ví dụ:
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    054 mang tính mô tả hơn là viết tắt thành
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    055 vì lợi ích của độ dài ký tự
  • Cố gắng sử dụng các ví dụ có liên quan trong thế giới thực trong đó mỗi biến có ngữ nghĩa rõ ràng. Chỉ quay lại các tên giữ chỗ như
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    056 và
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    057 khi ví dụ đơn giản và giả tạo
  • Không sử dụng quy ước đặt tên ký hiệu Hungary. Không đặt tiền tố tên biến với loại của nó. Ví dụ: viết
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    058 thay vì
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    059 hoặc
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    060 thay vì
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    061
  • Đối với các bộ sưu tập, tránh thêm các loại như danh sách, mảng, hàng đợi vào tên. Sử dụng tên nội dung ở dạng số nhiều. Ví dụ: đối với mảng ô tô, hãy sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    062 chứ không phải
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    063 hoặc
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    064. Có thể có các trường hợp ngoại lệ, chẳng hạn như khi bạn muốn hiển thị dạng trừu tượng của một đối tượng địa lý mà không có ngữ cảnh của một ứng dụng cụ thể
  • Đối với các giá trị nguyên thủy, hãy sử dụng camelCase, bắt đầu bằng ký tự chữ thường. Không sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    065. Sử dụng tên ngắn gọn, dễ đọc và có ngữ nghĩa khi thích hợp. Ví dụ: sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    066 thay vì
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    067
  • Tránh dùng mạo từ và tính sở hữu. Ví dụ: sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    068 thay vì
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    069 hoặc
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    070. Có thể có các trường hợp ngoại lệ, chẳng hạn như khi mô tả một đối tượng địa lý nói chung mà không có ngữ cảnh thực tế
  • Sử dụng tên biến như được hiển thị ở đây

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    20

    Không đặt tên biến như thế này

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    21

Ghi chú. Nơi duy nhất không được phép sử dụng các tên ngữ nghĩa, con người có thể đọc được là nơi tồn tại một quy ước được công nhận rất phổ biến, chẳng hạn như sử dụng

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
009 và
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
072 cho các trình vòng lặp

Khi khai báo biến, hằng dùng từ khóa

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
012 và
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
010, không dùng
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
075. Các ví dụ sau đây cho thấy những gì được đề xuất và những gì không được khuyến nghị trên MDN Web Docs

  • Nếu một biến sẽ không được gán lại, hãy ưu tiên
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    010, như vậy

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    22

  • Nếu bạn muốn thay đổi giá trị của một biến, hãy sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    012 như hình bên dưới

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    23

  • Ví dụ bên dưới sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    012 trong đó lẽ ra phải là
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    010. Mã này sẽ hoạt động, nhưng chúng tôi muốn tránh cách sử dụng này trong các ví dụ về mã MDN Web Docs

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    24

  • Ví dụ bên dưới sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    010 cho một biến được gán lại. Việc gán lại sẽ gây ra lỗi

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    25

  • Ví dụ dưới đây sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    075, gây ô nhiễm phạm vi toàn cầu

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    26

  • Khai báo một biến trên mỗi dòng, như vậy

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    27

    Không khai báo nhiều biến trên một dòng, phân tách chúng bằng dấu phẩy hoặc sử dụng khai báo chuỗi. Tránh khai báo các biến như thế này

    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    28

Tránh ép buộc kiểu ngầm định. Đặc biệt, tránh dùng

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
082 để buộc một giá trị thành một số và
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
083 để buộc nó thành một chuỗi. Thay vào đó, hãy sử dụng
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
084 và
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
085, không sử dụng
var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
086. Viết

var MAX_ITEM = 15
var URL = 'https://www.zyllem.com/discover-zyllem'
29

đừng viết

closeConnection();
0

Ngoài các tính năng ngôn ngữ JavaScript này, chúng tôi khuyên bạn nên ghi nhớ một số nguyên tắc liên quan đến API Web

Nếu tất cả các trình duyệt chính (Chrome, Edge, Firefox và Safari) đều hỗ trợ một tính năng, thì không thêm tiền tố vào tính năng đó. Viết

closeConnection();
1

Tránh sự phức tạp thêm vào của các tiền tố. đừng viết

closeConnection();
2

Quy tắc tương tự áp dụng cho các tiền tố CSS

Khi một phương thức, thuộc tính hoặc toàn bộ giao diện không được dùng nữa, đừng sử dụng nó (bên ngoài tài liệu của nó). Thay vào đó, hãy sử dụng API hiện đại

Dưới đây là danh sách không đầy đủ các API Web cần tránh và thay thế chúng bằng gì

  • Sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    087 thay vì XHR (
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    088)
  • Sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    089 thay vì
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    090, trong Web Audio API

  • Không sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    091 để chèn nội dung văn bản thuần túy vào một phần tử; . Thuộc tính
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    093 dẫn đến sự cố bảo mật nếu nhà phát triển không kiểm soát tham số. Chúng tôi, với tư cách là người viết, càng tránh sử dụng nó, thì càng có ít lỗi bảo mật được tạo ra khi nhà phát triển sao chép và dán mã của chúng tôi. Ví dụ dưới đây minh họa việc sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    094

    closeConnection();
    
    3

    Không sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    093 để chèn văn bản thuần túy vào các nút DOM

    closeConnection();
    
    4

  • Hàm
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    096 không đáng tin cậy. Nó không hoạt động trong các ví dụ trực tiếp trên MDN Web Docs bên trong một
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    097. Hơn nữa, nó là phương thức cho toàn bộ cửa sổ, điều này thật khó chịu. Trong các ví dụ về mã tĩnh, hãy sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    48 hoặc
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    49. Trong các ví dụ trực tiếp, tránh
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    48 và
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    49 vì chúng không được hiển thị. Sử dụng phần tử giao diện người dùng chuyên dụng

  • Khi đăng nhập một tin nhắn, hãy sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    48
  • Khi ghi lỗi, hãy sử dụng
    var MAX_ITEM = 15
    var URL = 'https://www.zyllem.com/discover-zyllem'
    49

Tham khảo ngôn ngữ JavaScript - duyệt qua các trang tham khảo JavaScript của chúng tôi để xem một số đoạn mã JavaScript hay, ngắn gọn, có ý nghĩa

Các quy ước đặt tên cho một chức năng được sử dụng trong JavaScript là gì?

Quy ước đặt tên . Tên biến và hàm viết dưới dạng camelCase . Các biến toàn cục được viết bằng HOA (Chúng tôi không, nhưng nó khá phổ biến) Các hằng số (như PI) được viết bằng HOA.

Quy tắc đặt tên cho tên hàm là gì?

Khi đặt tên cho hàm, biến hoặc lớp, bạn nên ghi nhớ những điều sau. .
Chọn một từ có nghĩa (cung cấp một số ngữ cảnh)
Tránh tên chung chung (như tmp )
Đính kèm thông tin bổ sung vào tên (sử dụng hậu tố hoặc tiền tố)
Đừng đặt tên quá dài hoặc quá ngắn
Sử dụng định dạng nhất quán

Là chức năng đặt tên quy ước?

Quy ước đặt tên cho hàm . Ngoài ra, bạn nên sử dụng các danh từ và động từ mô tả làm tiền tố. Ví dụ: nếu chúng ta khai báo một hàm để lấy tên, thì tên hàm phải là getName. the camel case approach is the recommended way to declare function names. In addition to that, you should use descriptive nouns and verbs as prefixes. For example, if we declare a function to retrieve a name, the function name should be getName.

Tên hàm có phải là camelCase không?

Theo Hướng dẫn về Phong cách PEP 8, tên hàm phải là chữ thường, với các từ được phân tách bằng dấu gạch dưới .