แบบแผนการตั้งชื่อ JavaScript [ปิด]

ฉันรู้ว่ามีข้อโต้แย้งมากมาย (อาจไม่ใช่ข้อโต้แย้ง แต่อย่างน้อยก็มีข้อโต้แย้ง) เกี่ยวกับแบบแผนการตั้งชื่อที่ดีที่สุดสำหรับ JavaScript

คุณตั้งชื่อตัวแปรฟังก์ชันวัตถุและสิ่งนั้นได้อย่างไร

ฉันจะทิ้งความคิดของฉันเองเกี่ยวกับเรื่องนี้เนื่องจากฉันไม่ได้ทำ JS มานาน (สองสามปีเท่านั้น) และฉันเพิ่งได้รับคำขอให้สร้างเอกสารที่มีแบบแผนการตั้งชื่อเพื่อใช้ในโครงการที่ทำงานของเรา . ดังนั้นฉันจึงได้ดู (google-ing) รอบ ๆ และมีความคิดเห็นที่แตกต่างกันมากมาย

หนังสือที่ฉันอ่านใน JS ใช้วิธีการตั้งชื่อต่าง ๆ ด้วยตัวเอง แต่พวกเขาก็เห็นด้วยเล็กน้อย:“ ค้นหาสิ่งที่เหมาะกับคุณและยึดมันไว้” แต่ตอนนี้ฉันได้อ่านหนังสือมากมายฉันพบว่าฉันชอบวิธีอื่นดีกว่าที่ฉันคุ้นเคย

ฉันทำตามข้อกำหนดของDouglas Crockfordสำหรับจาวาสคริปต์ ฉันยังใช้เครื่องมือJSLintของเขาเพื่อตรวจสอบการปฏิบัติตามอนุสัญญาเหล่านั้น

ขณะที่เจฟฟ์พูดสิ่งที่คร็อคฟอร์ดพูดนั้นดี

ข้อยกเว้นเดียวที่ฉันติดตาม (และเคยเห็นใช้กันอย่างแพร่หลาย) คือการใช้ $ varname เพื่อระบุวัตถุ jQuery (หรือไลบรารีใด ๆ ) เช่น

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

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

คุณสามารถติดตามสิ่งนี้ คู่มือสไตล์ของ Google JavaScript

โดยทั่วไปให้ใช้ functionNamesLikeThis, variableNamesLikeThis, ClassNamesLikeThis, EnumNamesLikeThis, methodNamesLikeThis และ SYMBOLIC_CONSTANTS_LIKE_THIS

แก้ไข: ดูคอลเลกชันที่ดีของJavaScript สไตล์คู่มือและ Beautifiers

หนึ่งการประชุมที่ฉันต้องการลองคือการตั้งชื่อโมดูลสแตติกด้วยคำนำหน้า 'the' ลองดู. เมื่อฉันใช้โมดูลของคนอื่นมันไม่ง่ายเลยที่จะดูว่าฉันควรจะใช้มันอย่างไร เช่น:

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

ฉันกำลังคิดเกี่ยวกับการลองใช้การประชุมที่โมดูลแบบคงที่ใช้ 'เพื่อ' บ่งบอกถึงความมีมาก่อนของพวกเขา มีใครเห็นวิธีที่ดีกว่านี้ไหม? จะมีลักษณะเช่นนี้:

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

ฉันคิดว่านอกเหนือจากข้อ จำกัด ทางไวยากรณ์ การตั้งชื่อการใช้เหตุผลเป็นภาษาที่อิสระมาก ฉันหมายถึงข้อโต้แย้งในความโปรดปรานของ c_style_functions และ JavaLikeCamelCase สามารถใช้ในทางตรงกันข้ามได้อย่างเท่าเทียมกันผู้ใช้ภาษามักจะติดตามผู้เขียนภาษา

ต้องบอกว่าฉันคิดว่าห้องสมุดส่วนใหญ่มักจะติดตาม CamelCase ของ Java อย่างง่าย ฉันพบว่าคำแนะนำของ Douglas Crockfordมีรสนิยมเพียงพอสำหรับฉัน

นั่นเป็นคำถามส่วนตัวที่อาจขึ้นอยู่กับว่าคุณทำงานอย่างไร บางคนชอบใส่ประเภทตัวแปรที่จุดเริ่มต้นของตัวแปรเช่น "str_message" และบางคนชอบใช้ขีดเส้นใต้ระหว่างคำของพวกเขา ("my_message") ในขณะที่คนอื่น ๆ ชอบที่จะแยกพวกเขาด้วยตัวอักษรตัวพิมพ์ใหญ่ ("myMessage")

ฉันมักจะทำงานกับห้องสมุด JavaScript ขนาดใหญ่ที่มีคนอื่นดังนั้นฟังก์ชั่นและตัวแปร (ยกเว้นตัวแปรส่วนตัวภายในฟังก์ชั่น) จะต้องเริ่มต้นด้วยชื่อของบริการเพื่อหลีกเลี่ยงความขัดแย้งในฐานะ "guestbook_message"

กล่าวโดยย่อ: ชื่อตัวแปรและฟังก์ชั่นภาษาอังกฤษที่ต่ำกว่าการจัดเรียงที่ดีเป็นสิ่งที่ดีกว่า ชื่อควรอธิบายการมีอยู่ของพวกเขามากกว่าที่จะสั้น