คำถามติดแท็ก comments

คำถามเกี่ยวกับการเขียนความคิดเห็นในรหัส

16
เกิดอะไรขึ้นกับความคิดเห็นที่อธิบายรหัสที่ซับซ้อน?
ผู้คนมากมายอ้างว่า "ความคิดเห็นควรอธิบาย" ทำไม "แต่ไม่ใช่" เป็นอย่างไร " บางคนบอกว่า "รหัสควรเป็นเอกสารด้วยตนเอง" และความคิดเห็นควรหายาก โรเบิร์ตซี. มาร์ตินอ้างว่า (พูดซ้ำตามคำพูดของฉัน) บ่อยครั้งที่ "ความคิดเห็นเป็นการขอโทษสำหรับการเขียนโค้ดที่ไม่ดี" คำถามของฉันมีดังต่อไปนี้: มีอะไรผิดปกติในการอธิบายอัลกอริทึมที่ซับซ้อนหรือโค้ดที่ยาวและซับซ้อนพร้อมความคิดเห็นเชิงอธิบาย ด้วยวิธีนี้แทนที่จะเป็นนักพัฒนาคนอื่น ๆ (รวมถึงตัวคุณเอง) ที่ต้องอ่านอัลกอริธึมทีละบรรทัดเพื่อหาว่ามันทำอะไรพวกเขาสามารถอ่านความคิดเห็นเชิงอธิบายที่เป็นมิตรที่คุณเขียนเป็นภาษาอังกฤษธรรมดา ภาษาอังกฤษได้รับการออกแบบเพื่อให้มนุษย์เข้าใจได้ง่าย อย่างไรก็ตาม Java, Ruby หรือ Perl ได้รับการออกแบบมาเพื่อสร้างความสมดุลระหว่างความสามารถในการอ่านของมนุษย์และความสามารถในการอ่านคอมพิวเตอร์ดังนั้นจึงทำให้ความสามารถในการอ่านข้อความของมนุษย์ลดลง มนุษย์สามารถเข้าใจภาษาอังกฤษได้เร็วขึ้นมากว่าเขา / เธอสามารถเข้าใจรหัสด้วยความหมายเดียวกัน (ตราบใดที่การดำเนินการนั้นไม่สำคัญ) ดังนั้นหลังจากเขียนโค้ดที่ซับซ้อนซึ่งเขียนด้วยภาษาการเขียนโปรแกรมที่มนุษย์สามารถอ่านได้บางส่วนทำไมไม่เพิ่มความคิดเห็นเชิงอธิบายที่กระชับและอธิบายการทำงานของโค้ดในภาษาอังกฤษที่เป็นมิตรและเข้าใจได้? บางคนจะพูดว่า "รหัสไม่ควรเข้าใจยาก", "ทำให้ฟังก์ชั่นเล็ก ๆ ", "ใช้ชื่อที่สื่อความหมาย", "อย่าเขียนรหัสสปาเก็ตตี้" แต่เราทุกคนรู้ว่าไม่เพียงพอ นี่เป็นเพียงแนวทาง - สิ่งสำคัญและมีประโยชน์ - แต่ไม่เปลี่ยนความจริงที่ว่าอัลกอริทึมบางอย่างมีความซับซ้อน และดังนั้นจึงยากที่จะเข้าใจเมื่ออ่านพวกเขาทีละบรรทัด เป็นเรื่องที่ไม่ดีหรือไม่ที่จะอธิบายอัลกอริทึมที่ซับซ้อนพร้อมความคิดเห็นสองสามบรรทัดเกี่ยวกับการทำงานทั่วไป เกิดอะไรขึ้นกับการอธิบายรหัสที่ซับซ้อนพร้อมความคิดเห็น

23
ฉันจะจัดการกับสมาชิกในทีมที่ไม่ชอบแสดงความคิดเห็นในโค้ดได้อย่างไร
หนึ่งในสมาชิกในทีมของฉันหลีกเลี่ยงการแสดงความคิดเห็นในรหัสของเขาอย่างสม่ำเสมอ รหัสของเขาไม่ใช่การทำเอกสารด้วยตนเองและโปรแกรมเมอร์คนอื่น ๆ มีช่วงเวลาที่ยากลำบากในการทำความเข้าใจโค้ดของเขา ฉันขอให้เขาแสดงความคิดเห็นรหัสของเขาหลายครั้ง แต่เขาแค่ให้ข้อแก้ตัวหรืออ้างว่าเขาจะทำในภายหลัง ความกังวลของเขาคือการเพิ่มความคิดเห็นจะใช้เวลามากเกินไปและล่าช้าโครงการ ฉันสามารถนำเสนอข้อโต้แย้งอะไรกับเขาเพื่อโน้มน้าวให้เขาจัดทำรหัสของเขาอย่างเหมาะสม? ในบันทึกนั้นฉันผิดที่จะมุ่งเน้นไปที่ความคิดเห็นของรหัสหรือสิ่งนี้บ่งบอกถึงปัญหาที่ใหญ่กว่าซึ่งควรได้รับการแก้ไขหรือไม่?
182 teamwork  team  comments 

17
มาตรฐานการเข้ารหัสเพื่อความชัดเจน: แสดงความคิดเห็นทุกบรรทัดของรหัส?
ฉันทำงานในร้านค้าที่ผลิตซอฟต์แวร์ที่สำคัญต่อชีวิตและฉันได้จัดการกับกฎการแสดงความคิดเห็นที่ตั้งใจจะให้โค้ดอ่านได้และอาจช่วยชีวิตผู้คนได้ จากประสบการณ์ของฉันแม้ว่าความต้องการจะกลายเป็นงานที่น่าเบื่อสมองที่ต้องทำเครื่องหมายในรายการตรวจสอบและไม่ช่วยให้ฉันจดจ่อกับการเขียนโค้ดที่เข้าใจได้ นอกจากนี้ยังเบี่ยงเบนความสนใจจากผู้ตรวจสอบเพียร์ของฉันจากการสนทนาที่มีความหมายกับฉันมากขึ้นเกี่ยวกับวิธีทำให้โค้ดง่ายต่อการเข้าใจ ฉันให้คะแนนรหัสนักเรียนที่ไม่มีความคิดเห็นและเห็นว่าเพราะเหตุใดพวกเขาจึงควรทำเครื่องหมายเพราะละเลยพวกเขา ฉันเข้าใจว่าการใช้ชื่อที่ดีโครงสร้างที่เรียบง่ายฟังก์ชั่นสั้น ๆ และโมดูลที่มุ่งเน้นจะทำให้โค้ดนั้นเข้าใจได้ง่ายพอที่จะลดความคิดเห็นได้ ฉันยังเข้าใจด้วยว่าความคิดเห็นควรอธิบายว่าทำไมรหัสทำในสิ่งที่มันทำไม่ได้อย่างไร ให้ทั้งหมดนี้เป็นไปได้ที่จะเขียนมาตรฐานการเข้ารหัสที่ดีที่จับความคิดนี้ คนที่จะมีความเกี่ยวข้องในการตรวจสอบโดยเพื่อน แต่จะไม่เปลี่ยนเป็นรายการตรวจสอบที่ไม่สนใจซึ่งทำให้โน้ตไม่เป็นประโยชน์มากกว่า: "คุณลืมแสดงความคิดเห็นในบรรทัดที่ 42" ตัวอย่างประเภทของรหัสกฎนี้อาจต้องใช้เมื่อถือว่าเป็นบรรทัดในรายการตรวจสอบ: /* Display an error message */ function display_error_message( $error_message ) { /* Display the error message */ echo $error_message; /* Exit the application */ exit(); } /* -------------------------------------------------------------------- */ /* Check if the configuration file does …

30
“ ความคิดเห็นเป็นกลิ่นรหัส” [ปิด]
ผู้ร่วมงานของผมเชื่อว่าการใด ๆ ที่ใช้ในการแสดงความคิดเห็นรหัส (เช่นไม่ใช่วิธีการรูปแบบ Javadoc หรือระดับความคิดเห็น) เป็นกลิ่นรหัส คุณคิดอย่างไร?

12
ลูกค้าของฉันต้องการ 25% ของความคิดเห็นในโครงการปัจจุบันของฉันวิธีการตอบสนอง? [ปิด]
นักพัฒนาจูเนียร์ที่นี่ ฉันกำลังทำงานคนเดียวในเว็บแอปพลิเคชันสำหรับลูกค้ารายใหญ่ของ บริษัท ของฉัน ฉันเริ่มเมื่อเดือนที่แล้ว ลูกค้าต้องการความเห็นอย่างน้อย 25% ในแต่ละโครงการซอฟต์แวร์ ฉันตรวจสอบรหัสของแอปพลิเคชันก่อนหน้าและนี่คือข้อสังเกตของฉัน: แต่ละไฟล์เริ่มต้นด้วยบล็อกความคิดเห็น (แพ็คเกจ, วันที่อัพเดทล่าสุด, ชื่อ บริษัท & ลิขสิทธิ์ของฉัน) ตัวแปรทั้งหมดจะถูกใส่ความคิดเห็นพร้อมชื่อ // nameOfCustomer public String nameOfCustomer getters และ setters ทั้งหมดถูกคอมเม้นต์ ความเห็นที่เป็นประโยชน์น้อยมาก ดูเหมือนว่านักพัฒนาเพียงแค่ใส่ความคิดเห็นให้มากที่สุดเท่าที่จะทำได้เพื่อให้ถึงขีด จำกัด นั้น 25% โดยไม่คำนึงถึงคุณภาพและประโยชน์ บริษัท ของฉันบอกฉันว่า "เราทำตามที่ลูกค้าต้องการ" ฉันไม่ได้พูดกับลูกค้าโดยตรงเกี่ยวกับเรื่องนี้ นี่คือข้อโต้แย้งของฉัน: บรรทัดที่ไร้ประโยชน์ในการอ่านและเขียน (เสียเวลา) บางครั้งความคิดเห็นไม่ได้รับการอัพเดต (แหล่งที่มาของความสับสน) นักพัฒนามีโอกาสน้อยที่จะใช้หรือเชื่อถือความคิดเห็นที่เป็นประโยชน์จริง คุณมีคำแนะนำเกี่ยวกับเรื่องนี้อย่างไร? ฉันจะจัดการกับสถานการณ์ได้อย่างไร

17
สิ่งที่ต้องทำความคิดเห็นทำให้รู้สึก? [ปิด]
ฉันกำลังทำงานในโครงการขนาดใหญ่พอสมควรและได้รับงานแปล มีป้ายกำกับจำนวนมากที่ไม่ได้รับการแปลและในขณะที่ฉันกำลังขุดหารหัสฉันพบรหัสชิ้นนี้ //TODO translations นี่ทำให้ฉันคิดถึงความรู้สึกของความคิดเห็นเหล่านี้กับตัวเอง (และคนอื่น ๆ ?) เพราะฉันรู้สึกว่านักพัฒนาส่วนใหญ่หลังจากที่พวกเขาทำโค้ดบางอย่างเสร็จแล้วและทำในสิ่งที่ควรจะทำ เพื่อรักษาหรือเพิ่มฟังก์ชันการทำงานใหม่ เพื่อที่TODOจะได้หายไปเป็นเวลานาน มันสมเหตุสมผลหรือไม่ที่จะเขียนความคิดเห็นนี้หรือควรเขียนลงในไวท์บอร์ด / กระดาษ / อย่างอื่นที่พวกเขายังคงอยู่ในความสนใจของนักพัฒนา?

9
ทำความสะอาดรหัสความคิดเห็นเกี่ยวกับเอกสารประกอบคลาส
ฉันกำลังคุยกับเพื่อนร่วมงานคนใหม่เกี่ยวกับการแสดงความคิดเห็น เราทั้งคู่ชอบClean Codeและฉันพอใจกับความจริงที่ว่าควรหลีกเลี่ยงการแสดงความคิดเห็นแบบอินไลน์โค้ดและควรใช้ชื่อคลาสและเมธอดเพื่อแสดงสิ่งที่พวกเขาทำ อย่างไรก็ตามฉันเป็นแฟนตัวยงของการเพิ่มบทสรุปของชั้นเรียนขนาดเล็กที่พยายามอธิบายจุดประสงค์ของชั้นเรียนและสิ่งที่เป็นตัวแทนจริง ๆ แล้วเพื่อให้ง่ายต่อการรักษารูปแบบหลักการความรับผิดชอบเดียว ฉันยังเคยเพิ่มบทสรุปแบบบรรทัดเดียวให้กับวิธีการที่อธิบายถึงวิธีการที่ควรทำ ตัวอย่างทั่วไปคือวิธีการง่าย ๆ public Product GetById(int productId) {...} ฉันกำลังเพิ่มสรุปวิธีการดังต่อไปนี้ /// <summary> /// Retrieves a product by its id, returns null if no product was found. /// </summary ฉันเชื่อว่าความจริงที่ว่าวิธีการคืนค่า null ควรมีการบันทึกไว้ ผู้พัฒนาที่ต้องการเรียกใช้เมธอดไม่ควรเปิดโค้ดของฉันเพื่อดูว่าเมธอดส่งคืน null หรือมีข้อผิดพลาดเกิดขึ้นหรือไม่ บางครั้งมันเป็นส่วนหนึ่งของอินเทอร์เฟซดังนั้นนักพัฒนาซอฟต์แวร์จึงไม่ทราบว่ารหัสอ้างอิงใดทำงานอยู่หรือไม่ อย่างไรก็ตามเพื่อนร่วมงานของฉันคิดว่าข้อคิดเห็นเหล่านี้เป็น " กลิ่นรหัส " และ "ความคิดเห็นมักจะล้มเหลว" ( Robert C. Martin …

13
รหัสความเห็นสามารถเป็นเอกสารที่มีค่าได้หรือไม่
ฉันเขียนรหัสต่อไปนี้: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } มีบรรทัดแสดงความคิดเห็นที่นี่ แต่ผมคิดว่ามันทำให้รหัสชัดเจนโดยการทำให้เห็นได้ชัดว่าสิ่งที่แตกต่างระหว่างและif elseความแตกต่างนั้นชัดเจนยิ่งขึ้นด้วยการเน้นสี การใส่ความคิดเห็นโค้ดเช่นนี้เป็นความคิดที่ดีได้หรือไม่

13
ตัวอย่างของความคิดเห็นที่บอกคุณว่าทำไมแทนที่จะเป็นอย่างไรหรืออะไร [ปิด]
ก่อนอื่นในคำถามนี้ฉันต้องการหลีกเลี่ยงการทะเลาะโต้เถียงกันว่าการคอมเม้นท์ซอร์สโค้ดดีหรือไม่ดี ฉันแค่พยายามเข้าใจให้ชัดเจนยิ่งขึ้นว่าผู้คนหมายถึงอะไรเมื่อพวกเขาพูดถึงความคิดเห็นที่บอกคุณว่าอะไรอะไรหรืออย่างไร เรามักจะเห็นแนวทางเช่น "ความคิดเห็นควรบอกคุณว่าทำไมโค้ดเองควรบอกคุณได้อย่างไร" มันง่ายที่จะเห็นด้วยกับคำสั่งในระดับนามธรรม อย่างไรก็ตามผู้คนมักจะทำสิ่งนี้เช่นความเชื่อและออกจากห้องโดยไม่มีคำอธิบายเพิ่มเติม ฉันเคยเห็นสิ่งนี้ใช้ในสถานที่และบริบทที่แตกต่างกันมากมายจนดูเหมือนว่าผู้คนสามารถเห็นด้วยกับวลีบทกลอน แต่ดูเหมือนว่าพวกเขากำลังพูดถึงสิ่งต่าง ๆ โดยสิ้นเชิง ดังนั้นกลับไปที่คำถาม: หากความคิดเห็นควรบอกคุณว่าทำไมนี่คือเหตุผลที่เรากำลังพูดถึง? นี่เป็นสาเหตุที่ทำไมส่วนของรหัสนั้นมีอยู่ตั้งแต่แรก? นี่คือสิ่งที่รหัสชิ้นควรจะทำอย่างไร ฉันจะขอบคุณจริง ๆ ถ้ามีคนให้คำอธิบายที่ชัดเจนแล้วเพิ่มตัวอย่างที่ดี (ไม่จำเป็นต้องมีตัวอย่างที่ไม่ดี แต่ลดลงเพื่อเพิ่มความคมชัด) มีคำถามมากมายเกี่ยวกับว่าความคิดเห็นดีหรือไม่ดี แต่ไม่มีใครตอบคำถามเฉพาะว่าอะไรเป็นตัวอย่างที่ดีของความคิดเห็นที่บอกคุณว่าทำไม

22
ฉันจะโน้มน้าวให้เพื่อน devs ของฉันเป็นต้องการที่จะเพิ่มความคิดเห็นไปยังรหัสที่มากระทำได้อย่างไร
ฉันรู้ว่าการโค่นล้ม (สิ่งที่เราใช้ในที่ทำงาน) สามารถกำหนดค่าให้ต้องแสดงความคิดเห็นในการกระทำ แต่ฉันไม่ได้อยู่ในตำแหน่งที่มีอำนาจเพียงแค่เปิดใช้งาน ฉันรู้ว่าฉันเหตุผลสำหรับการแสดงความคิดเห็นกระทำของฉันคือเพราะมันจะเป็นประโยชน์ถ้าเพียง แต่เป็นหน่วยความจำที่วิ่งได้อย่างรวดเร็วเข้าใจเหตุผลที่อยู่เบื้องหลังการกระทำ อย่างไรก็ตามนี่ดูเหมือนจะไม่เพียงพอที่จะต่อสู้กับคำตอบทั้งสองที่ฉันได้รับเสมอ: ใช้เวลานานเกินไปและฉันแค่ต้องการเปลี่ยนแปลงของฉันเป็น repo ง่ายพอที่จะดูความแตกต่าง ฉันยังแสดงให้พวกเขาเห็นคุณค่าของการเพียงแค่ใส่ ID ปัญหา JIRA และวิธีการเชื่อมโยงกับปัญหาโดยอัตโนมัติ แต่ก็ยังไม่มีลูกเต๋ากับพวกเขา ที่เลวร้ายที่สุดของทุกคนที่สามารถโทรออกอยู่ในค่ายเดียวกัน: ไม่ต้องการที่จะรำคาญและจะดีกับมองหาที่ diffs ฉันรู้ว่าเป็นสิ่งที่ถูกต้องที่จะทำ แต่ฉันจะทำให้พวกเขาเห็นแสงสว่างได้อย่างไร แม้ว่าฉันจะไม่สามารถโน้มน้าวเพื่อนร่วมงานของฉันได้ฉันจะโน้มน้าวผู้บริหารได้อย่างไรว่ามันเป็นสิ่งที่ถูกต้องที่จะทำเพื่อธุรกิจ

17
ฉันจะขอให้เจ้านายของฉันแสดงความคิดเห็นรหัสของเขาได้อย่างไร?
ฉันได้รับการสอนจากหัวหน้าของฉัน (ฉันเพิ่งเรียนจบและเขาต้องการใครสักคนที่มีประสบการณ์การเขียนโปรแกรมเล็กน้อยดังนั้นเขาจึงเลือกให้ฉันสอนสิ่งที่ บริษัท เชี่ยวชาญ) และเริ่มทำงานกับแอปพลิเคชันASP.NET MVC , HTML และ CSS บางตัว . ฉันพอใจกับการออกแบบเว็บไซต์ที่เขาให้ฉัน (มันค่อนข้างง่ายที่จะเข้าใจโดยไม่ต้องชี้แจง) แต่ตัวอย่างเช่นเขาให้ฉันทำงานกับ ASP.NET MVC เขาอธิบายได้ดีจริงๆ แต่เขาไม่ได้อธิบายอะไรในรหัสที่เขาเพิ่งให้ฉัน (เราใช้การควบคุมแหล่งที่มาในVisual Studio 2013 ) ดังนั้นจึงเป็นโค้ดหลายร้อยบรรทัดโดยไม่มีพื้นหลังเกี่ยวกับสิ่งที่ควรทำ รหัสที่ฉันเห็นคือรหัสที่ฉันไม่เคยเห็นมาก่อนดังนั้นจึงเป็นเรื่องยากที่จะลองและคิดออก ฉันจะลองและถามคำถามเขาเพิ่มเติม แต่เขาก็ทำงานอยู่เสมอ (เป็นธุรกิจของเขาเอง) และฉันรู้สึกราวกับว่าเขาอาจรำคาญกับคำถามเหล่านี้ทั้งหมดที่ฉันมีในมือของฉัน ดังนั้นสิ่งที่จะช่วยฉันออกไปจนกว่าฉันจะได้เข้าใจสิ่งต่าง ๆ ฉันจะขอให้เจ้านายของฉันใส่ความคิดเห็นลงในรหัสของเขาที่เขาให้ฉันได้อย่างไร แต่อย่างสุภาพ?
72 comments 

9
XXX หมายถึงอะไรในความคิดเห็น [ปิด]
คนทั่วไปหมายถึงอะไรเมื่อใดก็ตามที่คุณเห็นXXXในความคิดเห็น บางครั้งฉันจะเห็นความคิดเห็นเช่นนี้: # XXX - This widget really should frobulate the whatsit แน่นอนฉันสามารถบอกได้ว่าความคิดเห็นนั้นหมายถึงอะไร แต่ XXX โดยทั่วไปหมายถึงอะไร มันพูดว่า "นี่คือแฮ็ค" หรืออาจ "เราควรกลับมาทบทวนอีกครั้งในภายหลัง"? หรือมันจะพูดอย่างอื่นอย่างสิ้นเชิง?

16
ความคิดเห็นของคนแรกเบี่ยงเบนความสนใจและไม่เป็นมืออาชีพหรือไม่
ฉันเพิ่งพบว่าตัวเองกำลังเขียนความคิดเห็นต่อไปนี้ในบางรหัส (archaic Visual Basic 6.0) รหัสที่ฉันเขียน: If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if ฉันไม่แน่ใจว่าทำไมฉันจึงใช้ "เรา" โดยไม่รู้ตัวในความคิดเห็นของฉัน ฉันสงสัยว่าเป็นเพราะฉันจินตนาการว่ามีคนก้าวเข้ามาในรหัสราวกับว่าพวกเขากำลัง "ทำ" คำสั่งทั้งหมดในแต่ละบรรทัดมากกว่าที่จะเห็นพวกเขาเกิดขึ้น ด้วยความคิดนี้ฉันสามารถใช้I can resize itเพราะฉันเป็นคนหนึ่งที่ "กำลังทำ" อยู่ในขณะนี้หรือyou can resize itราวกับว่าฉันกำลังพูดกับใครก็ตามคือ "ทำ" มันในอนาคต แต่เนื่องจากทั้งสองกรณีนี้มีแนวโน้มมากที่สุด เกิดขึ้นฉันใช้ "เรา" ราวกับว่าฉันกำลังนำใครบางคนผ่านรหัสของฉัน ฉันสามารถเขียนใหม่เป็นit can be resizedและหลีกเลี่ยงปัญหา แต่มันจุดประกายความอยากรู้ของฉัน: …

7
แสดงความคิดเห็นสิ่งที่ต้องทำด้วยกำหนดเวลา?
พื้นหลัง ฉันกำลังทำงานในทีมที่ต้องการปรับใช้การปรับใช้แบบไม่ต้องหยุดทำงาน เราวางแผนที่จะใช้กลยุทธ์การปรับใช้สีน้ำเงิน / เขียวเพื่อให้บรรลุเป้าหมายนี้ สิ่งหนึ่งที่ฉันตระหนักในการทำวิจัยคือความซับซ้อนของการเปลี่ยนแปลงฐานข้อมูล การดำเนินการอย่างง่ายเช่นการเปลี่ยนชื่อคอลัมน์อาจใช้เวลา3 รอบเต็มจนกว่าจะเสร็จสมบูรณ์! สำหรับฉันดูเหมือนว่าการมีการเปลี่ยนแปลงอย่างเต็มรูปแบบนั้นต้องใช้เวลาหลายรอบการเปิดตัวทำให้เกิดข้อผิดพลาดของมนุษย์ได้มาก ในบทความที่เชื่อมโยงมันแสดงให้เห็นว่าการเปลี่ยนแปลงรหัสมีความจำเป็นสำหรับ 2 รุ่นและการโยกย้ายฐานข้อมูลเป็นสิ่งจำเป็นสำหรับ 3 รุ่น สิ่งที่ฉันกำลังมองหา ในปัจจุบันหากเราต้องการจำบางสิ่งเราสามารถสร้างตั๋วในระบบการจัดการปัญหาของเราซึ่งสร้างความยุ่งเหยิงและอาจถูกย้ายไปที่การวิ่งในภายหลังหรือการค้างโดยผู้บริหาร หรือเราสามารถสร้างความคิดเห็นสิ่งที่ต้องทำซึ่งอาจจะถูกลืมไปโดยสิ้นเชิง สิ่งที่ฉันกำลังมองหาคือวิธีที่ความคิดเห็นของ TODO สามารถกำหนดเส้นตายได้และระบบการรวมอย่างต่อเนื่องของเรา (ไม่แน่ใจว่าเราจะใช้ในปัจจุบัน) จะปฏิเสธการสร้างหากกำหนดเวลานี้หมดอายุ ตัวอย่างเช่นถ้าเราเปลี่ยนชื่อคอลัมน์เราสามารถสร้างการโยกย้ายครั้งแรกสำหรับมันและจากนั้นสองความคิดเห็นสิ่งที่ต้องทำเพื่อให้แน่ใจว่าการย้ายสองที่เหลือจะถูกสร้างขึ้น: // TODO by v55: Create migration to move constraints to new column, remove references to old column in app // TODO by v56: Create migration to drop …

11
เหตุใด /// บล็อกความคิดเห็นจึงมีความสำคัญ
มีคนเคยกล่าวว่าเราควรนำหน้าวิธีการทั้งหมดของเราด้วย /// <summary>บล็อกความคิดเห็น (C #) แต่ไม่ได้อธิบายว่าทำไม ฉันเริ่มใช้พวกเขาและพบว่าพวกเขาทำให้ฉันรำคาญเล็กน้อยดังนั้นหยุดใช้พวกเขายกเว้นห้องสมุดและวิธีการคงที่ พวกมันเทอะทะและฉันก็ลืมที่จะอัพเดทอยู่เสมอ มีเหตุผลที่ดีที่ใช้/// <summary>บล็อคความคิดเห็นในรหัสของคุณหรือไม่ ปกติฉันจะใช้//ความคิดเห็นตลอดเวลามันเป็นเพียง/// <summary>ช่วงเวลาที่ฉันสงสัย
49 c#  comments 

โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.