코드 주석에 프로그래밍 Q & A/레서피 링크 배치

Question

빠른 질문 : StackOverflow Q & A와 레시피 링크를 코드 주석에 삽입하기 시작하여 특정 트릭을 발견 한 곳을 생각 나게합니다.

QA/recipe를 좀 더 영구적 인 (그러나 중복 된) 설명으로 변환해야합니까? 내가 코멘트 코드에서 Q & A와 조리법 링크를 배치 생각하지 않는다

감사합니다,

마이크

Answer 1

전혀 좋은 생각이다. 주된 이유는 코드 내부의 주석에 지식 기반을 유지하고 있기 때문입니다. 이 자료를 쉽게 참조 할 수있는 방법은 없습니다. 컨텍스트를 원한다면 별도의 문서 또는 위키와 링크 및 Q & A를 보관하는 것이 좋습니다. 코드 샘플을 문서/위키에 복사하십시오. Wiki 내부를 링크 할 수 있고 외부 사이트로 연결할 수 있기 때문에 위키를 설정할 수 있다면 위키를 사용하는 것이 좋습니다.