ตกลงหรือไม่ที่จะใส่ลิงค์ไปยังเว็บไซต์ถาม - ตอบในความคิดเห็นของโปรแกรม

ในบาง codebase คุณสามารถเห็นความคิดเห็นที่ระบุเช่น:

 // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade)

ดังนั้นฉันมีคำถามสองสามข้อ แต่ทั้งหมดเกี่ยวข้องกัน

ตกลงหรือไม่ที่จะใส่ลิงก์ไปยังคำถาม SO ในความคิดเห็นของโปรแกรม:

 // We're now mapping from the "sorted-on column" to original indices.
 //
 // There's apparently no easy way to do this in Java, so we're
 // re-inventing a wheel.
 //
 // (see why here, in SO question: http://stackoverflow.com/questions/951848)

คุณทำมันได้หรือไม่

และสิ่งที่เป็นข้อเสียในการทำเช่นนั้น? (ดูความคิดเห็นแรกของฉันสำหรับข้อเสียอย่างสาหัส)

ฉันทำไปแล้วอาจจะไม่ใช่เฉพาะสำหรับ Stack Overflow แต่สำหรับบล็อกทางเทคนิคฟอรัม Usenet กลุ่ม Google หรือสถานที่อื่น ๆ ที่ "ทำไมฉันถึงทำแบบนี้" อาจไม่ชัดเจนจากบริบท

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

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

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

ในทางที่ดีโค้ดของคุณไม่จำเป็นต้องมีความคิดเห็นดังกล่าวเพราะมันมีโครงสร้างที่ดี ฯลฯ แต่ใช่เมื่อสถานการณ์ของคุณน้อยกว่าอุดมคติมันเป็นที่ยอมรับที่จะใส่ความคิดเห็นเช่นนี้ และลิงก์ไปยัง stackoverflow.com นั้นดี (และมักจะดีกว่า!) มากกว่าลิงก์อื่น ๆ

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

ฉันยังไม่ได้ใส่ลิงค์ StackOverflow.com ในรหัสของฉัน ฉันพยายามหลีกเลี่ยงการใส่ลิงค์ในโค้ดเนื่องจากเป็นกลิ่นที่ไม่ดี แต่เมื่อถึงเวลาฉันจะไม่ลังเล

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

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

ดังที่มีคนพูดถึง SO เป็นสไตล์ของวิกิดังนั้นจึงเป็นไปได้ที่มันจะเปลี่ยน แต่โดยทั่วไปแล้วความคิดก็ควรจะเหมือนเดิม

คุณควรให้เครดิตแก่ผู้อื่นเมื่อคุณใช้ความคิดของพวกเขา

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

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