프로그램 설명에 Q & A 사이트에 대한 링크를 넣는 것이 괜찮습니까?

일부 코드베이스에서는 다음과 같은 내용의 주석을 볼 수 있습니다.

 // 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)

당신은 그것을합니까?

그리고 그렇게 할 때의 단점은 무엇입니까? (끔찍한 단점은 내 첫 번째 의견 참조)

스택 오버플로를 위해 특별히하지는 않았지만 기술 블로그, 포럼, 유즈넷, Google 그룹스 또는 "이 작업을 수행 한 이유"가 문맥에서 완전히 명확하지 않을 수 있습니다.

나는 그들이 그렇게 생각하지는 않지만 확실하지 않은 오래된 질문을 보관하고 제거하지 않는 한 왜 이렇게 SO를 사용하는 것이 나쁜 일인지 알지 못합니다. 다른 사이트보다 더 나쁩니다.

정말 걱정된다면 언제든지 스크린 샷을 찍거나 텍스트로 다운로드하거나 이미지, 스타일 시트 등을 가져 와서 회사의 지식 저장소에 저장하여 첨부 파일을 첨부 할 수 있습니다 고유 식별자를 사용하고 주석에 고유 식별자를 추가하면 나중에 참조 할 수 있습니다. 그러면 이러한 유형의 일관된 위치가됩니다. 그러나 코드의 복잡성과 중요성에 따라 과도 할 수 있습니다.

일반적으로이 링크를 만드는 가장 좋은 방법은 버전 관리 시스템 및 / 또는 버그 추적 시스템을 사용하는 것입니다. 이 기능을 사용하려면 코드를 버그 추적기 또는 버전 관리 시스템의 주석에 정확하게 배치 할 수 있어야합니다.

이상적으로는 코드가 잘 구성되어 있기 때문에 코드에 주석이 필요하지 않습니다. 그러나 상황이 이상적이지 않은 경우 에는 이와 같은 주석을 넣을 수 있습니다. 그리고 stackoverflow.com에 대한 링크는 다른 것보다 우수합니다 (종종 더 우수합니다!).

그들이 일시적인 의견이 되길 바랍니다. 다시 와서 코드를 개선하고 의견을들을 수있게 되길 바랍니다 .

아직 내 코드에 StackOverflow.com 링크를 넣지 않았습니다. 냄새가 나기 때문에 코드에 링크를 넣지 않으려 고하지만 시간이 오면 망설이지 않습니다.

편집 : 위의 답변은 이와 같은 의견의 필요성을 피할 수 있다고 생각합니다. 물론 때로는 피할 수 없습니다 . 라이브러리의 버그이거나 제어 할 수없는 잘못된 API 디자인입니다. 링크를 포함한 이와 같은 의견은 다음 개발자에게 도움이 될 것입니다.

나는 연구 논문을 쓰는 것처럼 본다. 다른 사람의 아이디어를 사용하는 경우 해당 아이디어에 대한 크레딧을 제공해야합니다. 이전에 코드에서 stackoverflow의 답변을 사용했으며 메소드 주석에 대한 링크를 추가했습니다.

누군가 언급했듯이 SO는 위키 스타일이므로 변경 될 수는 있지만 일반적으로 아이디어는 동일해야합니다.

자신의 아이디어를 사용할 때도 다른 사람에게 신용을 제공해야합니다.

해결 방법을 구현해야하는데 왜 구현이 특정 방식으로 수행 되었는지 명확하지 않은 경우에는 그 이유를 식별 할 수 있어야합니다. 온라인 참조에 대한 링크를 배치하는 것은 좋지만 실제로는 간결하게 의견을 작성해야하지만 독자가 귀하의 추론을 두 번 확인해야 할 경우 링크가 확장 된 설명 만 제공 할 수있을 정도로 충분히 완성하십시오.

반면에 코드가 그대로 복사 된 경우 원본 소스에 대한 링크는 공정하며 원본 저자의 저작물을 복사 할 수있는 라이센스 문구에 따라 필요할 수 있습니다.