Wulin.com (www.vevb.com) บทนำบทความ: ฉันไม่เคยเห็นการวิจัยทางวิทยาศาสตร์ใด ๆ พิสูจน์สิ่งนี้ แต่ในสาขาซอฟต์แวร์มันเป็นเหมือนความเชื่อหรือความเชื่อทั่วไป เนื่องจากการมีอยู่ของมันเป็นสิ่งสำคัญในการเขียนซอฟต์แวร์ได้อย่างง่ายดายและให้ความสนใจกับประเภทของรหัสที่อ่านได้ ข้อกำหนดเหล่านี้สามารถทำได้ผ่านเทคนิคบางอย่างซึ่งหนึ่งในนั้นคือการเขียนความคิดเห็นของรหัส
ข้อจำกัดความรับผิดชอบ: สิ่งที่ฉันพูดเกี่ยวกับการหลีกเลี่ยงความคิดเห็นของรหัสไม่ได้หมายความว่าฉันไม่ได้เขียนความคิดเห็นซึ่งหมายความว่าฉันหลีกเลี่ยงการเขียนความคิดเห็นโค้ดให้มากที่สุด แต่ฉันก็ยังเขียนพวกเขาเมื่อฉันรู้สึกว่ามันคุ้มค่า
เราใช้เวลาอ่านซอฟต์แวร์มากกว่าการเขียนซอฟต์แวร์และฉันไม่เคยเห็นการวิจัยทางวิทยาศาสตร์ใด ๆ พิสูจน์สิ่งนี้ แต่ในสาขาซอฟต์แวร์มันเป็นเหมือนความเชื่อหรือความเชื่อทั่วไป เนื่องจากการมีอยู่ของมันเป็นสิ่งสำคัญในการเขียนซอฟต์แวร์ได้อย่างง่ายดายและให้ความสนใจกับประเภทของรหัสที่อ่านได้ ข้อกำหนดเหล่านี้สามารถทำได้ผ่านเทคนิคบางอย่างซึ่งหนึ่งในนั้นคือการเขียนความคิดเห็นของรหัส
เมื่อพูดถึงความคิดเห็นของรหัสมีการอภิปรายที่ไม่มีที่สิ้นสุดเสมอ เราควรใช้ความคิดเห็นเพื่อแสดงบทบาทของรหัสของเราหรือไม่? เราควรมุ่งเน้นไปที่การแสดงออกของรหัสโดยไม่จำเป็นต้องมีความคิดเห็นเพื่อช่วยในการอ่านหรือไม่? Joe Kunk เขียนบล็อกเกี่ยวกับการโต้แย้ง - คุณไม่ควรเขียนความคิดเห็น บางคนบอกว่ารหัสที่มีเอกสารที่ดีถือเป็นรหัสที่ดีและบางคนบอกว่าควรหลีกเลี่ยงความคิดเห็นเพราะความคิดเห็นมักใช้เพื่ออธิบาย/ซ่อนรหัสที่ไม่ดี
ในความคิดของฉันภายใต้อิทธิพลของหนังสือเพื่อให้แน่ใจว่ารหัสนั้นเรียบร้อยและง่ายต่อการ refactor เราควรหลีกเลี่ยงการเขียนความคิดเห็นเว้นแต่ว่าเรามีเหตุผลที่ดีในการเขียนความคิดเห็น (เช่นอัลกอริทึมทางคณิตศาสตร์) หรือเนื่องจากข้อกำหนดหรือกระบวนการของ บริษัท เราจำเป็นต้องทำเช่นนั้น ต่อไปนี้เป็นข้อกังวลห้าประการเกี่ยวกับบันทึกย่อ
ที่ฉันคิดว่ารหัสความคิดเห็นทำงานตอบโต้ผลกระทบ 1. ความคิดเห็นมักจะส่งเสริมรหัสที่ไม่ดีรหัสความคิดเห็นเป็นรหัสที่ดีมีคำพูดเช่นนี้ดังนั้นผู้คนมักจะเพิ่มความคิดเห็นลงในรหัสเพื่อให้รหัสสวยงาม หากเราเพิ่มความคิดเห็นเพื่อตีความรหัสมันเป็นสัญญาณ: บางทีเราอาจจะเขียนรหัสที่ไม่ดี เมื่อเราต้องการเขียนความคิดเห็นเราควรสงสัยว่าเราสามารถอ่านได้มากขึ้นโดยการทำความสะอาดรหัส
2. เราจะใช้เวลาในการเขียนและการบำรุงรักษามากขึ้นความคิดเห็นมักจะเป็นเวอร์ชันที่สองของรหัส เรากำลังทำซ้ำตัวเองเมื่อเราเขียนความคิดเห็นสำหรับฟังก์ชั่น เราละเมิดหลักการแห้ง (อย่าทำซ้ำตัวเอง) เราใช้เวลามากขึ้นและเพิ่มความซับซ้อน หากข้อกำหนดเปลี่ยนแปลงรหัสจะต้องเปลี่ยนแปลงและหากเราเขียนความคิดเห็นเราจะต้องเปลี่ยนพวกเขาด้วย ดังนั้นทำการเปลี่ยนแปลงเป็นสองเท่าของเวลาที่คุณใช้ เราสามารถใช้เวลานี้เพื่อปรับปรุงรหัสของเราหรือพัฒนาคุณสมบัติใหม่
3. ความคิดเห็นไม่สามารถทดสอบและตรวจสอบได้เมื่อเราแก้ไขรหัสเราใช้คอมไพเลอร์ IDES และเครื่องมือทดสอบหน่วยเพื่อช่วยเหลือและไม่มีความคิดเห็นและไม่มีเครื่องมือที่คล้ายกัน คุณไม่สามารถพึ่งพาเครื่องมือหรือการทดสอบหน่วยเพื่อให้แน่ใจว่าใช้อย่างถูกต้องวันที่มีคำอธิบายประกอบวันที่ ฯลฯ เมื่อคุณเขียนความคิดเห็นเพราะมันไม่สามารถคาดเดาได้และไม่สามารถให้ความสนใจกับความถูกต้องของมันมันจะถูกเก็บรักษาไว้อย่างไม่ถูกต้องเมื่อมันผิดพลาด
4. ความคิดเห็นไม่น่าเชื่อถือเมื่อเทียบกับรหัสโดยปกติเมื่อความคิดเห็นและรหัสออกจากมันมันจะมีความหมายน้อยลง หากโปรแกรมเมอร์อ่านมันอาจถูกเข้าใจผิด แม้จะไม่มีการทำให้เข้าใจผิดคุณต้องอ่านซอร์สโค้ดเพื่อหาว่าคุณกำลังทำอะไรอยู่ สำหรับตัวอย่างที่เป็นประโยชน์หากเจ้านายของเราต้องการให้เราทำการดัดแปลงเราควรดูความคิดเห็นหรือรหัสหรือไม่? แน่นอนเราจะดูรหัส
5. ความคิดเห็นใช้พื้นที่หน้าจอมากมายวิธีการแสดงความคิดเห็นบางอย่าง (เช่นเดียวกับที่ด้านล่าง) ใช้สายจำนวนมากซึ่งกลายเป็นปัญหาเมื่อคุณต้องการดูรหัสเพิ่มเติม
-
-
* @param ชื่อชื่อเรื่องของซีดี
* @Param ผู้แต่งผู้แต่งซีดี
* @param ติดตามจำนวนแทร็กบนซีดี
* @param durationinmutes ระยะเวลาของซีดีในไม่กี่นาที
-
โมฆะสาธารณะ addcd (ชื่อสตริง, สตริงผู้แต่ง,
แทร็ก int, durationinminutes) {
cd cd = cd ใหม่ ();
cd.title = ชื่อ;
cd.author = ผู้แต่ง;
cd.tracks = แทร็ก;
CD.Duration = ระยะเวลา;
cdlist.add (CD);
-