Các quy ước đặt tên JavaScript [đã đóng]

Tôi biết có rất nhiều tranh cãi (có thể không phải là tranh cãi, nhưng ít nhất là tranh luận) về quy ước đặt tên nào là tốt nhất cho JavaScript.

Làm thế nào để bạn đặt tên cho các biến, chức năng, đối tượng của bạn và như vậy?

Tôi sẽ để ý nghĩ của mình về điều này, vì tôi đã không làm JS lâu (chỉ vài năm thôi) và tôi vừa nhận được yêu cầu tạo một tài liệu với các quy ước đặt tên được sử dụng trong các dự án của chúng tôi tại nơi làm việc . Vì vậy, tôi đã tìm kiếm (google-ing) xung quanh và có rất nhiều ý kiến ​​khác nhau.

Những cuốn sách tôi đã đọc trên JS cũng sử dụng các quy ước đặt tên khác nhau, nhưng tất cả chúng đều đồng ý về một bit: Tìm Tìm những gì phù hợp với bạn và tuân theo nó. Nhưng bây giờ tôi đã đọc rất nhiều xung quanh, tôi thấy rằng tôi thích một số phương pháp khác tốt hơn một chút so với những gì tôi đã sử dụng cho đến bây giờ.

Tôi tuân theo các quy ước mã của Douglas Crockford cho javascript. Tôi cũng sử dụng công cụ JSLint của mình để xác thực theo các quy ước đó.

Như Geoff nói, những gì Crockford nói là tốt.

Ngoại lệ duy nhất tôi theo dõi (và đã thấy được sử dụng rộng rãi) là sử dụng $ varname để chỉ ra một đối tượng jQuery (hoặc bất kỳ thư viện nào). Ví dụ

var footer = document.getElementById('footer');

var $footer = $('#footer');

Bạn có thể làm theo Hướng dẫn về Phong cách Google JavaScript này

Nói chung, hãy sử dụng hàmNamesLike This, biếnNamesLike This, ClassNamesLike This, EnumNamesLike This, methodNamesLike This và SYMBOLIC_CONSTANTS_LIKE_THIS.

EDIT: Xem bộ sưu tập đẹp về Hướng dẫn và làm đẹp JavaScript .

Một quy ước tôi muốn thử là đặt tên các mô-đun tĩnh với tiền tố 'the'. Kiểm tra này. Khi tôi sử dụng mô-đun của người khác, không dễ để thấy tôi nên sử dụng mô-đun như thế nào. ví dụ:

define(['Lightbox'],function(Lightbox) {
  var myLightbox = new Lightbox() // not sure whether this is a constructor (non-static) or not
  myLightbox.show('hello')
})

Tôi đang suy nghĩ về việc thử một quy ước trong đó các mô-đun tĩnh sử dụng 'the' để biểu thị tính phổ biến của chúng. Có ai nhìn thấy một cách tốt hơn thế này? Sẽ như thế này:

define(['theLightbox'],function(theLightbox) {
  theLightbox.show('hello') // since I recognize the 'the' convention, I know it's static
})

Tôi nghĩ rằng bên cạnh một số hạn chế cú pháp; các quy ước đặt tên là rất nhiều ngôn ngữ độc lập. Ý tôi là, các đối số có lợi cho c_style_fifts và JavaLikeCamelCase cũng có thể được sử dụng theo cách ngược lại, đó chỉ là người dùng ngôn ngữ có xu hướng theo dõi các tác giả ngôn ngữ.

đã nói rằng, tôi nghĩ rằng hầu hết các thư viện có xu hướng theo cách đơn giản hóa CamelCase của Java. Tôi thấy lời khuyên của Douglas Crockford đủ trang nhã cho tôi.

Đó là một câu hỏi cá nhân có thể phụ thuộc vào cách bạn làm việc. Một số người thích đặt loại biến ở đầu biến, như "str_message". Và một số người thích sử dụng dấu gạch dưới giữa các từ của họ ("my_message") trong khi những người khác thích phân tách chúng bằng các chữ cái viết hoa ("myMessage").

Tôi thường làm việc với các thư viện JavaScript lớn với những người khác, vì vậy các hàm và biến (ngoại trừ các biến riêng tư bên trong các hàm) phải bắt đầu bằng tên của dịch vụ để tránh xung đột, như "guestbook_message".

Nói tóm lại: tiếng Anh, tên biến và tên hàm được sắp xếp tốt, được tổ chức tốt là tốt hơn theo tôi. Các tên nên mô tả sự tồn tại của họ chứ không phải là ngắn.