การจัดการกับความหยาบคายในซอร์สโค้ด [ปิด]

ผู้คนจัดการกับคำหยาบคายในซอร์สโค้ดและข้อคิดเห็น VCS อย่างไร เก็บหรือลบ?

สิ่งที่เกี่ยวกับ soft-expletives เช่น WTF หรือ Arrgggh

ไม่เป็นมืออาชีพเป็นที่น่ารังเกียจหรือบางสิ่งบางอย่างที่จะยักไหล่ออก?

ควรท้ออย่างเบา ๆ

.. คุณไม่สามารถรู้ได้ว่าใครจะได้เห็นซอร์สโค้ดตลอดอายุการใช้งาน

ในขณะที่มันเป็นส่วนหนึ่งของงานทั้งหมดที่จะได้รับความผิดหวังด้วยรหัสที่ซับซ้อนหรือเก่าโดยเฉพาะและต้องการที่จะฟังเกี่ยวกับเรื่องนี้การใส่ expletives / rants / ASCII art / jokes / bad / การกล่าวร้ายที่ไม่เหมาะสมลงในซอร์สโค้ดนั้น ความคิดที่ไม่ดีในประสบการณ์ของฉัน บางครั้งวิศวกรที่เขียนความคิดเห็นจะไม่สนใจผลกระทบในที่สุดความคิดเห็นของเขาอาจมี - นี่เป็นเพียงบางประเด็นที่ฉันเห็น:

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

ในขณะที่เราทุกคนจำเป็นต้องมีร้านค้าบางแห่งสำหรับแห้ว / สนุก / japing เกี่ยวกับรหัสที่มาไม่ใช่สถานที่ที่จะทำเช่นนี้ IMO คุณจะไม่ใส่คำสบถ / ความคิดเห็นที่น่ารังเกียจในสัญญาหน้าช่วยเหลือพิมพ์เขียวหรือเอกสารมืออาชีพอื่น ๆ แม้ว่าเอกสารเหล่านั้นอาจจะอ่านน้อยกว่าซอร์สโค้ดก็ตาม

หากหัวหน้าทีมได้รับสิ่งที่ถนัดอย่างหนักมันจะต้องโกรธดังนั้นฉันจึงพูดว่า 'ท้อใจเบา ๆ ' ด้วยคำพูดที่เงียบ ๆ กับวิศวกรที่มีปัญหาและจัดหากลไกการระบายอากาศที่เหมาะสมเพื่อปลดปล่อยไอ ฮอกกี้อากาศหรือถุงหมัด

มันไม่มีอะไรจะพูดได้ว่าคอมไพล์คอมไพล์แล้ว - เกี่ยวกับ JavaScript, หรือโค้ดฝั่งไคลเอ็นต์แบบไดนามิกอื่น ๆ ?

นี่คือประสบการณ์ในโลกแห่งความจริงที่ฉันเคยเห็น

• ในขณะที่ทำงานกับ Microsoft ฉันพบว่าวิศวกรซอฟต์แวร์หนึ่งไม่รู้การสะกดที่ถูกต้องของ "ไม่" - เขาพลาด o, l และ d - และได้อ่านรหัสของเขาด้วยคำอธิบายที่ยาวนานว่าเขาไม่สามารถทำให้ X ทำงานเพราะคน Y ทำให้เกิดปัญหา Z รหัสของเขายอดเยี่ยม การสะกดคำของเขาไม่ค่อยดีนัก พอที่จะพูดว่าผู้ตรวจสอบของรหัสนี้ (เช่นฉัน) ใด ๆ ที่ตามมาก็ตกใจที่จะเห็นการสาบานแบบสุ่มจำนวนมากในรหัส รหัสนี้บางส่วนจะปรากฏต่อพันธมิตร (ผู้เขียนไดรเวอร์) ลองนึกภาพสยองขวัญของพวกเขาที่เห็นสาบาน การพูดจาโผงผางควรเป็นไปตามผู้จัดการโครงการในรูปแบบของวาจา (ซึ่งในกรณีที่บุคคล Y อาจถูกดึงเข้าสู่การสนทนา) หรืออาจส่งข้อความ แต่ไม่ใช่ในแหล่งที่มา

• ที่ บริษัท หนึ่งแห่งบุคคลที่พูดภาษาต่างประเทศได้เข้าร่วมทีมที่พูดภาษาอังกฤษเป็นหลัก เขาเขียนความคิดเห็นด้วยภาษาของเขาโดยคิดว่าไม่มีใครสามารถอ่านได้ นี่เป็นเรื่องปกติจนกระทั่ง Babelfish / Google Translate ออกตัวเลือก 'เป็นภาษาอังกฤษ' สำหรับภาษาของเขาซึ่งเป็นจุดที่คนอื่น ๆ ในทีมแปลความคิดเห็นเล็กน้อยและตกใจต่อความคิดเห็นที่สกปรกและมักทำให้เสื่อมเสีย ทีมของเขาและผู้ร่วมงานหญิง อึดอัด

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

ลบชื่อ / ข้อมูลเฉพาะเพื่อปกป้องผู้บริสุทธิ์

หากคุณขายซอร์สโค้ดของคุณ (เช่นคุณเป็นผู้เขียนส่วนประกอบ) อาจไม่ควรอยู่ในนั้น

ถ้ามันเป็นเรื่องของความรอบคอบแล้วอะไรก็แล้วแต่คุณ

หากคุณเห็นคนเขียน WTF จำนวนมากอาจเป็นสัญญาณว่าคุณควรพูดคุยกับพวกเขาเกี่ยวกับปัญหาที่พวกเขามี

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

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

ฉันทำงานให้กับ บริษัท ที่ติดอันดับ Fortune 500 ที่ออกแบบผลิตและจำหน่ายผลิตภัณฑ์เพื่อผู้บริโภคที่มี runningControllers ที่ใช้รหัสที่พัฒนาขึ้นภายใน บริษัท การดำเนินคดีเป็นไปได้เสมอไม่ว่าจะจากผู้บริโภคที่คาดหวังว่าจะได้รับอย่างรวดเร็ว ด้วยเหตุนี้เราจึงเขียนโค้ดและความคิดเห็นทั้งหมดที่มีความรู้ที่อาจ (อาจจะ) ตกอยู่ภายใต้การพิจารณาของคณะลูกขุนที่เป็นมิตรในบางครั้ง นั่นหมายความว่าตัวแปรและฟังก์ชั่นชื่อไม่ควรมีคำ inciteful KILL_CHILD(int process_id)เช่น ในขณะที่วัตถุประสงค์ของฟังก์ชั่นตัวอย่างนี้เป็นไปได้อย่างดีที่จะยุติกระบวนการของเด็กคณะลูกขุนที่เป็นศัตรูจะดูชื่อฟังก์ชั่นนั้นได้อย่างไรถ้าลูกของโจทก์ถูกฆ่าตายในขณะที่ใช้ผลิตภัณฑ์

ความคิดเห็นในรหัสอาจเลวร้ายยิ่งกว่าเดิม ในขณะที่ทีมป้องกันที่เหมาะสมอาจจัดการอธิบายว่ากระบวนการลูกคืออะไร (จากตัวอย่างก่อนหน้านี้) และทำไมมันถึงต้องถูกยกเลิกมันเกือบจะเป็นไปไม่ได้เลยที่จะป้องกันความคิดเห็นเช่น:

// The following section of code is REALLY BAD!!!  I hope
//  it doesn't burn anybody's house down.

ความคิดเห็นนอกมือเช่นนี้เป็นปัจจัยในการตัดสินคดีจริง

ในหัวข้อที่เกี่ยวข้องชื่อของโครงการอาจเป็นอันตรายเมื่อภายใต้กล้องจุลทรรศน์ของการดำเนินคดีที่รุนแรง คุณจำความโกลาหลจากกลุ่มอนุรักษ์นิยมในช่วงกลางยุค 90 เมื่อแหล่งข่าวเทคโนโลยีรายงานว่า"SATAN Unleashed บนอินเทอร์เน็ต"หรือไม่?

<rant_mode_off>

จากทั้งหมดที่กล่าวว่าสำหรับโครงการส่วนบุคคลคุณมีอิสระที่จะทำสิ่งที่คุณต้องการในรหัสของคุณ

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

อย่างไรก็ตามถ้ามันรบกวนจิตใจคุณและไม่มีใครสนใจคุณอาจจะดูดมัน

ฉันอาจไม่ใช่คนที่เหมาะสมที่จะถามเพราะฉันมักจะใช้คำหยาบคายเล็กน้อย

ฉันคิดว่าส่วนใหญ่ขึ้นอยู่กับสภาพแวดล้อมของพีซีของคุณ (ถูกต้องทางการเมือง)

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

สำหรับฉันแล้วดูเหมือนว่าในสหรัฐอเมริกาและประเทศอื่น ๆ บางคนมีพีซีมากกว่า (หรือติดขัด) มากกว่าในเนเธอร์แลนด์ที่ฉันอาศัยและทำงานอยู่

ในฐานะโบนัสเพิ่มเติมนี่คือสถิติเกี่ยวกับการดูหมิ่นในรหัส: http://andrewvos.com/2011/02/21/amount-of-profanity-in-git-commit-messages-permprogramming-language/

ฉันมีแนวโน้มที่จะยอมรับว่ามันอาจจะไม่เป็นมืออาชีพ แต่ทุกคนสบถเป็นครั้งคราวดังนั้นฉันพยายามที่จะไม่ยึดติดกับผู้อื่น ที่กล่าวว่า codebase มีแนวโน้มที่จะสะท้อนให้เห็นถึงความเป็นมืออาชีพโดยรวมของกลุ่มดังนั้น codebase ที่เต็มไปด้วยภาระสามารถสะท้อนให้เห็นถึงกลุ่มที่ไม่เป็นมืออาชีพและการประชุมอาจจะต้องมีเพื่อที่จะ ในทำนองเดียวกันหากแนวโน้มบางอย่างปรากฏในรหัสอาจเป็นตัวบ่งชี้ปัญหาทั่วไปภายในกลุ่มที่ต้องแก้ไข (เช่น API ที่คุณใช้งานอยู่มีปัญหาที่ทำให้นักพัฒนาหงุดหงิด)

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

นี่เป็นมืออาชีพไม่พอใจหรืออะไรที่จะยักไหล่

อาจเป็นได้ทั้งสาม ... ขึ้นอยู่กับมุมมองของคุณ

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

ถ้าฉันเป็นคุณฉันจะยักออกนอกเสียจากว่าคุณเต็มใจที่จะทำให้ตัวเองไม่เป็นที่นิยมกับเพื่อนร่วมงานของคุณ

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

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

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

โดยส่วนตัวฉันคิดว่าสิ่งที่ไม่ใช่ลูกค้าหันหน้าไปทาง (เช่นวัสดุการกระทำภายใน) ไม่ใช่ปัญหาใหญ่

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

วิธีแก้ปัญหาอย่างรวดเร็วสำหรับปัญหานี้คือการติดตั้งตัวกรองคำหยาบในระบบควบคุมแหล่งที่มาของคุณ

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

/ * * igor: ฉันจะทำให้ตัวเองเป็นที่สาธารณะมากขึ้นหรือไม่ * Frankenstein: เอ่ออิกอร์ฉันจะสืบทอดจากคุณลักษณะที่ดีที่สุดของคุณ ... * /

มันเป็นแบบนี้มานาน เขาสร้างวัตถุสองชิ้นที่เรียกว่าคุณเดาได้ว่า: Frankenstein และ Igor เป็นส่วนหนึ่งของการตรวจสุขภาพจิต จริงๆแล้วมันสร้างสรรค์มาก แต่เสียเวลาทั้งหมด ฉันอยากเห็น WTF หรือ expletives มากกว่าบทภาพยนตร์ระหว่างสองวัตถุ C # สองรายการ ...

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

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

ที่กล่าวว่าฉันไม่ได้ใช้คำสบถ แต่ฉันจะใช้สิ่งต่าง ๆ เช่น "Doh!" เป็นครั้งคราว หรือ "หือ?" ซึ่งไม่แตกต่างกันในจิตวิญญาณ หากมันรบกวนจิตใจคุณพูดคุยกับผู้กระทำผิดอาจไม่ได้คิดถึงมัน ถ้าพวกเขาบอกให้คุณไต่เขาและคุณรู้สึกอย่างแรงกล้าให้ไปที่ผู้จัดการ หากคุณไม่ได้รับการสนับสนุนจากผู้จัดการคุณจะต้องเรียนรู้ที่จะอยู่กับมันหรือไปที่อื่น

ฉันไม่แน่ใจอย่างแน่นอนว่าคุณควรจะพูดอะไรเกี่ยวกับรหัสเช่นนี้:

tocommit = (n + (COMMITSIZE/PAGESIZE) - 1) & ~(COMMITSIZE/PAGESIZE - 1);

รหัสนี้ถูกดึงมาจาก codebase ที่แท้จริงและโหดเหี้ยมที่สุดฉันได้พยายามเพิ่มประสิทธิภาพเมื่อเร็ว ๆ นี้ (รหัสเป็นโอเพ่นซอร์สดังนั้นฉันจึงไม่เปิดเผยความลับของนายจ้างที่นี่หรืออะไรก็ตาม)

อย่างที่คนอื่น ๆ พูดขึ้นอยู่กับที่ทำงานและใครจะเห็นซอร์สโค้ด

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

ขณะนี้บิลด์เซิร์ฟเวอร์ของฉันรายงานเกี่ยวกับ OMG, WTF, kludge, ระเบียบและสิ่งที่ต้องทำในฐานะตัวชี้วัดของการล้างข้อมูลที่เหลือให้ทำตอนนี้พวกเขาเป็นส่วนหนึ่งของกระบวนการ

หากคุณเห็นคำหยาบคายในซอฟต์แวร์โอเพ่นซอร์สและต้องการกำจัดมันให้เตรียมความพร้อมสำหรับความเป็นไปได้ในการผลักดันกลับ อย่าเพิ่งเขียนรายงานบั๊กสามบรรทัดและคาดว่าจะได้รับการยอมรับ เขียนเรียงความขนาดเล็กอธิบายว่าทำไมภาษาหยาบคายและพินิจพิเคราะห์ไม่ดีและปฏิเสธข้อโต้แย้งล่วงหน้า

ฉันคิดว่ามันเป็นเรื่องของการตั้งค่าส่วนตัว สิ่งนั้นไม่ได้รบกวนฉันจริงๆดังนั้นฉันอาจจะทิ้งมันไว้ อาจให้คำแนะนำแก่ฉันว่าพื้นที่ที่มีปัญหาอยู่ในรหัสหรือไม่

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