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 Show TL; DR
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
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àmTê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à 16, nó giống với tên hàm trả về booleanNó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ụ: 17, 0, 1 đề xuất kiểu dữ liệu là số. 2, 3 nghe như chuỗi. Tên biến gồm một ký tự như 11, 12, 13 thường được dành riêng để sử dụng trong các vòng lặpTên vô nghĩa cũng nên tránh, chẳng hạn như 14, 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ừ.
Ví dụĐiều này cũng áp dụng cho TS
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à 5, quy ước Unix. Để giúp bạn, chúng tôi đã đưa tệp 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
Đừng làm điều này trong khi tạo mảng 0Khi thêm các mục vào một mảng, hãy sử dụng 7 và không gán trực tiếp. Xét mảng sau 2Thêm các mục vào mảng như thế này 3Đừng thêm các mục vào mảng như thế này 4Viế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
Khi có thể sử dụng cả hai kỹ thuật, chúng tôi thích sử dụng cú pháp 8/ 9 đơn giản hơn. Thật không may, bạn không thể sử dụng 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 9 cấp cao nhấtNhậ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ọ
Nhận xét một dòng được đánh dấu bằng 44, trái ngược với nhận xét khối được đặt giữa 45Nó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 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 45 trong khi gỡ lỗi
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 44 ở đầu mỗi dòng 04Không sử dụng 45 05Bỏ 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 ( 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àoSử 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 06Đừng sử dụng dấu chấm lửng (...) như thế này 07Khi 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 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 ( 44) 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 09Không sử dụng tên chức năng như thế này 20
Khi cần có vòng lặp, hãy chọn vòng lặp thích hợp từ 97, 98, 99, v.v.
Cảnh báo. Không bao giờ sử dụng 015 với mảng và chuỗiGhi chú. Cân nhắc hoàn toàn không sử dụng vòng lặp 016. Nếu bạn đang sử dụng 003 (hoặc 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ư 019, 020, 021, 022, 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 024. Nếu câu lệnh 025 kết thúc bằng 026, không thêm câu lệnh 027Tiếp tục ngay sau câu lệnh 025. Viết 36Đừng viết 37Mặc dù các câu lệnh luồng điều khiển như 025, 016 và 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 38đừng viết 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
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
Để 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 46Đừng tạo một đối tượng chung chung như thế này 47
Để định nghĩa các phương thức, hãy sử dụng cú pháp định nghĩa phương thức 10Thay vì 11
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 024. Quy tắc này cũng áp dụng khi trả về một giá trị. Viết 14Đừng viết 15Toá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 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 16Khô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 17Nếu bạn cần sử dụng 045 hoặc 046, hãy nhớ rằng 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 048 và 049, không phải 050 và 051, trừ khi các loại giá trị trung thực hoặc giả khác nhau được xử lý khác nhauChuỗi ký tự có thể được đặt trong dấu nháy đơn, như trong 052, hoặc trong dấu ngoặc kép, như trong 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
Tên biến tốt là điều cần thiết để hiểu mã
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 009 và 072 cho các trình vòng lặpKhi khai báo biến, hằng dùng từ khóa 012 và 010, không dùng 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
Tránh ép buộc kiểu ngầm định. Đặc biệt, tránh dùng 082 để buộc một giá trị thành một số và 083 để buộc nó thành một chuỗi. Thay vào đó, hãy sử dụng 084 và 085, không sử dụng 086. Viết 29đừng viết 0Ngoà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 1Tránh sự phức tạp thêm vào của các tiền tố. đừng viết 2Quy 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ì
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 . |