ฉันรู้ว่ามันได้รับการพิสูจน์แล้วว่ามาตรฐานการเข้ารหัสช่วยอย่างมหาศาล อย่างไรก็ตามมีเครื่องมือและ IDE ที่แตกต่างกันมากมายซึ่งจะจัดรูปแบบตามมาตรฐานที่โปรแกรมเมอร์ต้องการ ตราบใดที่รหัสของเรียบร้อย / แสดงความคิดเห็น (และไม่ยุ่งระเบียบปาเก็ตตี้) ฉันไม่เห็นความต้องการมาตรฐานการเข้ารหัส

มีข้อโต้แย้งใด ๆ สำหรับการพัฒนามาตรฐานการเข้ารหัส (เราไม่มี แต่มีการสร้าง)

อย่างไรก็ตามมีเครื่องมือและ IDE ที่แตกต่างกันมากมายซึ่งจะจัดรูปแบบตามมาตรฐานที่โปรแกรมเมอร์ต้องการ

ขอให้โชคดี ประสบการณ์ของฉันมีเครื่องมือจำนวนเล็กน้อย (ศูนย์!) ที่สามารถฟอร์แมตโค้ดจากฟอร์แมต X เป็นฟอร์แมต Y ได้อย่างถูกต้องมีหลายสิ่งหลายอย่างที่ขวางทาง แท็บเทียบกับพื้นที่เว้นวรรคงบหลายบรรทัด ฯลฯ เพียงแค่ดูที่การนำ GNU ไปใช้กับไฟล์ไลบรารีมาตรฐาน C ++ สิ่งที่คุณสามารถทำได้คือทำให้ IDE ของคุณทำคือใช้ช่องว่างแทนแท็บและไม่ต้องฟอร์แมตโค้ดต่างประเทศอีกต่อไป ตอนนี้โค้ดของคุณจะเป็นแบบที่คุณชอบและโค้ดต่างประเทศก็จะมีลักษณะเหมือนที่ผู้เขียนต้นฉบับเขียนไว้

สไตล์การเยื้องที่เฉพาะเจาะจงเป็นสิ่งสุดท้ายที่มาตรฐานการเข้ารหัสควรระบุ นั่นคือการเริ่มต้นสงครามศาสนาในการเขียนโปรแกรม IMO มาตรฐานการเข้ารหัสควรระบุชุดของรูปแบบการเยื้องที่เหมาะสม แต่ให้รายละเอียดเฉพาะกับผู้แต่งแพ็คเกจ สไตล์การเยื้องหรือควรเป็นส่วนเล็ก ๆ ของมาตรฐานการเข้ารหัส กฎการเข้ารหัสเลขศูนย์เป็นศูนย์: อย่าทำเรื่องเล็ก ๆ น้อย ๆ สไตล์การเยื้องเป็นเรื่องเล็ก

สิ่งที่ใหญ่กว่า:

• ฉันจะตั้งชื่อสิ่งต่าง ๆ ได้อย่างไร
• มีการ จำกัด บางส่วนของภาษาหรือไม่?
• รหัสจำเป็นต้องรวบรวมข้อมูลใหม่ทั้งหมดและด้วยการตั้งค่าคอมไพเลอร์ใด ๆ
• รหัสต้องผ่านการวัดบางอย่างหรือไม่?
• ต้องการการทดสอบประเภทใด
• ต้องใช้เอกสารประเภทใดทั้งในรหัส (ความคิดเห็น) และที่อื่น ๆ
• ที่สำคัญที่สุดฉันจะได้รับการยกเว้นตามมาตรฐานได้อย่างไร

ภาคผนวก
บางทีสิ่งที่สำคัญกว่านั้นก็คือสิ่งที่ไม่ควรใส่ในมาตรฐานการเข้ารหัส หัวข้อต่างๆเช่นวิธีการเขียนข้อกำหนดไม่ได้อยู่ในมาตรฐานการเข้ารหัส รายละเอียดเกี่ยวกับการทดสอบไม่ได้อยู่ในนั้น โครงการไม่ควรใช้มาตรฐานการเข้ารหัสเป็นแบบสแตนด์อะโลนสำหรับแผนการจัดการโครงการแผนการจัดการทดสอบการตรวจสอบและแผนการตรวจสอบความถูกต้องเป็นต้นเป้าหมายของมาตรฐานการเข้ารหัสคือการปรับปรุงความปลอดภัยของรหัสคุณภาพความเข้าใจการบำรุงรักษา และ "ilities" อื่น ๆ มีหลายวิธีที่จะทำให้แน่ใจว่าสิ่งนี้จะไม่เกิดขึ้น เพียงไม่กี่: ทำให้มาตรฐานหนังสือมีความซับซ้อนเช่นเดียวกับกฎหมายภาษีของประเทศบางอย่างเอาตัวรอดจากการเขียนโปรแกรมสงครามศาสนามีอนุสัญญาการตั้งชื่อไม่ดี

มาตรฐานการเข้ารหัสอาจมีผลที่ไม่ตั้งใจ ตัวอย่าง: คนโง่ของวิศวกรโครงการกำลังตีความ "ไม่มีหมายเลขเวทมนตร์" เพื่อหมายถึงสิ่งนั้นif (index == 0) {...}และfor (ii = 0; ii < 3; ++ii) {...}ต้องเปลี่ยนเป็นif (ZERO == index) {}และfor (ii = ZERO; ii < NUMBER_OF_DIMENSIONS_IN_THE_UNIVERSE; ++ii) {...}อย่าหัวเราะ ฉันเคยเห็นมันเกิดขึ้น ทุกวันนี้เมื่อฉันเขียนมาตรฐานการเข้ารหัสมันเป็น "ไม่มีเวทมนตร์หมายเลขแนวทาง" มากกว่ากฎที่จะรับมือกับความโง่เขลาแบบนี้

มาตรฐานการเข้ารหัสไม่ใช่การป้องกันหมายเลขหนึ่งสำหรับรูปแบบการเขียนโปรแกรมที่ไม่ดี / การเขียนโค้ดอันตราย การตรวจสอบรหัสคือ แม้จะมีระบบอัตโนมัติเป็นเวลาหลายปี แต่ก็ยังไม่มีอะไรดีไปกว่าการที่ดวงตาของคนมองเห็นและผ่านการตัดสินด้วยรหัส

มาตรฐานการเข้ารหัสไม่เพียง แต่เกี่ยวกับพารามิเตอร์ที่ได้รับความนิยมเท่านั้นindentแต่ยังรวมถึงการตั้งชื่อการประชุมการแสดงความคิดเห็นและคำแนะนำที่เป็นไปได้สำหรับสำนวนการใช้คุณสมบัติภาษาเป็นต้น

ยิ่งไปกว่านั้นคุณยังต้องจัดทำเอกสารทั้งหมดนี้ที่ไหนสักแห่ง และในที่สุดทุกคนก็ไม่ต้องการใช้ IDE ที่ปรับรูปแบบโค้ดใหม่ในแบบที่ ...

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

หากแต่ละคนให้ IDE ปรับรูปแบบโค้ดให้กับการเลือกของพวกเขาคุณมีหนึ่งในสองปัญหา: คุณต้องแน่ใจว่าคุณแปลงมันกลับเป็นรูปแบบดั้งเดิมเสมอเมื่อบันทึกหรือประสบจากความจริงที่ว่า diff ของคุณจะมีเสียงดังมาก ทำให้ยากที่จะเห็นสิ่งที่มีการเปลี่ยนแปลงในตรรกะของรหัส

คำตอบสั้น:ใช่มันไม่สะท้อนให้เห็นถึงคุณภาพ

มันคืออะไรและทำไมเราต้องการมัน?

มาตรฐานการเข้ารหัสเป็นส่วนสำคัญของซอฟต์แวร์คุณภาพสูง พวกเขาเพิ่มผลผลิตในกระบวนการพัฒนาทำให้การบำรุงรักษาโค้ดง่ายขึ้นและป้องกันไม่ให้โค้ดถูกผูกไว้กับบุคคลหรือทีมใดทีมหนึ่ง ความสอดคล้องในมาตรฐานการเข้ารหัสยังสร้างความแตกต่างของรหัสที่สร้างขึ้นก่อนเวลาอันยาวนานจากงานศิลปะที่ได้รับการออกแบบมาอย่างดี

ตกลงนักพัฒนาทุกคนรู้ว่าการเข้ารหัสเป็นสิ่งที่ดี แต่มาตรฐานควรมาจากไหน

ส่วนใหญ่จะกำหนดโดยผู้ขายที่เป็นเจ้าของผลิตภัณฑ์ นักพัฒนาซอฟต์แวร์ทุกคนสามารถเลือกได้จากมาตรฐานการเข้ารหัสอุตสาหกรรมมากมาย แนวทางการนำเสนอของ บริษัท บางแห่ง Microsoft, Oracle และ Sun Microsystems

มีข้อโต้แย้งใด ๆ สำหรับการพัฒนามาตรฐานการเข้ารหัส (เราไม่มี แต่มีการสร้าง)

ใช่มีมาตรฐานอุตสาหกรรมที่แนะนำให้ใช้ อย่างไรก็ตามแต่ละมาตรฐานการเข้ารหัสมีความเฉพาะเจาะจงสำหรับแพลตฟอร์มการพัฒนา ดังนั้นมาตรฐานการเข้ารหัสส่วนใหญ่เป็นภาษาเฉพาะ ตัวอย่างเช่น Java มีมาตรฐานที่แตกต่างจาก. NET ตัวอย่างเช่นC # .NET ใช้มาตรฐานนั้นในการอ้างอิงนี้

มาตรฐานทั่วไป

มาตรฐานทั่วไปไม่มีการพึ่งพาภาษาการเขียนโปรแกรมใด ๆ นอกเหนือไปจากมาตรฐานของผู้ขายเสนออาคาอุตสาหกรรมกล่าวถึงมาตรฐานการเข้ารหัสมีข้อความที่แตกต่างกันเช่นการเขียนโปรแกรมภาษาฮังการีโน้ตหรือCamelCase ฉันคิดว่ามาตรฐานการเข้ารหัสของ Microsoft .NET นั้นมาจากพื้นฐานของสัญลักษณ์ CamelCase

มาตรฐานและแนวทางการเข้ารหัสของทีม

ในความคิดทีมพัฒนาทุกคนควรเห็นด้วยกับมาตรฐานการเข้ารหัสทันทีที่เริ่มโครงการ แนวทางการเขียนโค้ดมักจะถูกสร้างขึ้นโดยหัวหน้าทีมหรือหัวหน้าสถาปนิกของ บริษัท มักจะเป็นเอกสารเปิดที่ต้องติดตามและปรับปรุงตามความต้องการ ตัวอย่างเช่นใน บริษัท ของเราเรามีหน้า Wiki ที่เอกสารนี้ถูกอัพโหลดและพร้อมใช้งานสำหรับนักพัฒนา บริษัท

ฉันจะใช้ความเห็นแย้งและพูดว่าไม่มีคุณไม่จำเป็นต้องมีมาตรฐานการเข้ารหัส อย่างที่คุณบอกว่าเป็นแนวทางที่บังคับใช้ IDE วิธีปฏิบัติที่ดีที่สุดทั่วไปที่ทุกคนใน บริษัท ทุกแห่งควรปฏิบัติ ผ่านการเขียนโปรแกรมคู่หรือความคิดเห็นรหัส

สิ่งที่เราควรตั้งชื่อตัวแปรนี้อย่างไร เราควรใช้คุณสมบัติภาษาใด เราควรหลีกเลี่ยง การทดสอบใดดีที่สุด เหล่านี้จะซ้ายที่ดีที่สุดที่ยังไม่ได้จนกว่าเราจะพบปัญหาที่กำหนดไว้อย่างหวุดหวิดว่าเรากำลังทำงานอยู่ในขณะนี้

ตกผลึกจากการตัดสินใจในนาทีเหล่านี้มาตรฐาน / รูปแบบที่ไม่เป็นทางการภายในทีมอาจเกิดขึ้นตามจุดตัดกับโดเมนปัญหาปัจจุบันและเทคโนโลยีที่ใช้งาน การประมวลผลวิธีการเหล่านี้เราคิดว่าสิ่งต่าง ๆ เช่นมาตรฐานการตั้งชื่อชุดย่อยภาษาที่เหมาะสม ฯลฯ ที่ใช้ในโครงการเหล่านี้ขึ้นอยู่กับการตัดสินใจหลายร้อยครั้งและทีมงานเหล่านี้นำมาใช้อย่างไม่เป็นทางการ

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

หากคุณต้องการคำแนะนำที่แท้จริงแทนที่จะอ่านมาตรฐานที่มีกฎที่ไร้ประโยชน์มากมายไปหาสมาชิกที่มีความสามารถในทีมของคุณและถามพวกเขาว่าพวกเขาคิดอย่างไร พวกเขาถูกเผาอะไร? พวกเขาแนะนำให้คุณเขียนรหัสอย่างไร คุณจะได้รับคำตอบที่เป็นประโยชน์มากมายพร้อมด้วยประสบการณ์อันมีค่ามากมายในการสำรองข้อมูล คุณจะเห็นจุดแยกมากตามประสบการณ์ทั่วไป แทนที่จะเป็นแบบเชิงเดี่ยวที่บังคับใช้ตามมาตรฐานคุณจะเห็นความหลากหลายมากมายซึ่งสามารถช่วยให้คุณเห็นวิธีที่ถูกต้องในการแก้ปัญหาเท่านั้น

และเมื่อมีคนบอกคุณว่าอย่าทำสิ่งที่ทำให้เกิดกฎใน "มาตรฐาน" แต่ไม่มีประสบการณ์หรือการสำรองข้อมูลที่สมเหตุสมผลในการอ้างสิทธิ์ของพวกเขาให้เพิกเฉยต่อพวกเขา ที่นี่มาตรฐานไม่ได้ทำหน้าที่ทุกคนหรือทำให้ทุกคนเป็นนักพัฒนาที่ดีขึ้น

ตอนนี้เครื่องบินพาณิชย์เป็นแบบบินต่อโดยสายคุณจะหวังว่าโปรแกรมที่บินบนเครื่องบินจะขึ้นอยู่กับการทำงานของนักบิน เมื่อโปรแกรมเมอร์เขียนโค้ดดังกล่าวคุณหวังว่าพวกเขาจะปฏิบัติตามชุดกฎที่เข้มงวดเพื่อหลีกเลี่ยงข้อผิดพลาดในการเขียนโปรแกรมแบบทั่วไปที่หลีกเลี่ยงได้ วิธีหนึ่งในการทำเช่นนี้คือกับมาตรฐานการเข้ารหัส

ดู: เสนอมาตรฐานการบริหารการบินของรัฐบาลกลาง C และ C ++

ฉันต้องการพูดมากกว่านี้

หมายเหตุ: ฉันไม่สามารถหามาตรฐานจริงจาก FAA ออนไลน์ได้ แต่ฉันได้เห็นแล้ว

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

ต้องบอกว่าฉันจะทำให้มาตรฐานการเข้ารหัสในมุมมอง IDE และ / หรือเครื่องมือที่ใช้ นอกจากนี้ IDE ควรได้รับการกำหนดค่าเหมือนกัน (เช่น IDE ของนักพัฒนาแต่ละคนควรใช้แท็บทั้งหมดหรือพื้นที่สีขาวทั้งหมดสำหรับการเยื้องและ IDE ของทุกคนควรมีความยาวแท็บเดียวกัน) สำหรับนักพัฒนาแต่ละคนเพื่อให้ทุกคนสามารถปฏิบัติตามมาตรฐานได้อย่างง่ายดาย ...

นอกจากนี้สคริปต์เช็คอินสามารถพัฒนาและใช้งานได้ซึ่งอาจช่วยในการปฏิบัติตามมาตรฐานการเข้ารหัสในระดับหนึ่งเช่นสามารถแก้ไขการเยื้องก่อนที่จะส่งไฟล์ที่เช็คอินเข้าสู่ระบบควบคุมเวอร์ชันได้

มาตรฐานการเข้ารหัสอาจไม่สำคัญอีกต่อไป! ฉันเป็นผู้ใช้ CakePHP ตัวยงและฉันต้องการตรวจสอบการเปลี่ยนแปลงจากรุ่นสู่รุ่นและนักพัฒนาไม่ปฏิบัติตามมาตรฐานที่นั่น

ในความเป็นจริงผมก็เสียใจมากจากความแตกต่างในรูปแบบที่ผมต้องเขียนพูดจาโผงผางสั้นเกี่ยวกับการเข้ารหัสประชุม มันเสียเวลาและค่าใช้จ่ายมากมายที่จะนำนักพัฒนาใหม่เข้ามาในทีมที่มีอยู่แล้ว - ลองจินตนาการว่าจะนำนักพัฒนาใหม่เข้ามาโดยไม่มีมาตรฐาน ... การเรียนรู้รหัสจะเป็นไปไม่ได้อีกแล้ว