34
기본적으로 질문은 다음과 같습니다. 내 Visual Studio 프로젝트와 관련된 텍스트 개발자 문서는 어디에 저장해야합니까?Visual Studio 프로젝트에 개발자 문서를 추가하는 가장 좋은 방법
정교하게 : XML 주석은 훌륭하지만 모든 사용 사례를 다루지는 않습니다. 때로는 상위 수준에서 프로젝트의 클래스 아키텍처를 설명하고 라이브러리에 사용법 메모를 추가하거나이 프로젝트에서 작업하는 차세대 개발자에게 다른 종류의 메시지를 남기려는 경우가 있습니다.
이러한 문서를 Visual Studio 프로젝트에 파일로 직접 추가하여 (a) 더 이상 검색하지 않고 개발자가 사용할 수 있고 (b) 버전 관리가되어 있는지 확인하십시오 (동일한 svn/git/소스 코드와 같은 저장소).
현재 프로젝트에 폴더 _Documentation을 추가하고 텍스트 파일을 사용하지만 이것이 최선의 해결책인지 잘 모르겠습니다. Visual Studio에는 자동으로 단어 줄 바꿈 텍스트 에 대한 옵션이 없으며 변경이있을 때마다 수동으로 줄 바꿈을 수정합니다. 반면에 Word 문서는 버전 제어 기능과 잘 작동하지 않으며 TeX는 각 개발자 PC에서 설정하고 가르치는 데 너무 많은 번거 로움이 있습니다.
잘 수립 된 모범 사례가 있습니까?
1 나는 편집/고급/워드 랩가 있다는 것을 알고 있지만 이것은 단지 디스플레이 아니라 파일 자체에 영향을 미칩니다.
[http://stackoverflow.com/questions/7820013/insert-image-in-code-cs-file][1]가 도움이되는지 확인하십시오. [1] : http://stackoverflow.com/questions/7820013/insert-image-in-code-cs-file – Ram
나는 똑같은 워크 플로우를 가지고있다. 이 문제를 아직 해결하지 못했습니까? 이 목적을 위해 시각적 인 스튜디오 확장을 쓰려고 생각하고 있습니다. 정보를 좀 좋아할 것입니다! – MHGameWork
@MHGameWork : 아직, 우리는 현재 솔루션에 추가 된 간단한 텍스트 파일을 사용하고 있습니다. 다행스럽게도 지금은 많은 고급 문서가 필요하지 않습니다. – Heinzi