0

Visual Studio에서 코드를 더 빠르게 문서화 할 수있는 멋진 기능이 있습니까?Visual Studio 빌트인 "XML Doc"기능 또는 무료 추가 기능

나는 프리미엄을 사용합니다.

나는 '///'자동 메소드에 대한 XML 주석을 생성하지만 메소드, 클래스 및/또는 어셈블리에 대한 추가 문서 도움말을 제공하기 위해 스텁이나 기타 바로 가기에 추가 정보를 추가하는 방법이 있습니까?

저는 팀의 개발 표준을 개발하기 위해 노력하고 있으며, 가능한 경우보다 쉽게 ​​생활하기를 원합니다.

결과 도움말 파일을 생성하기 위해 Sandcastle을 사용할 것입니다.

답변

1

SubMain GhostDoc - '자동 문서 작성자'를 믿을 수 없으며, 과도하고 불필요한 문서가 단순히 잡음을 추가한다고 생각합니다.하지만 GhostDoc은 실수로 프로젝트를 수행하는 데 시간을 절약 할만큼 효과적입니다. 리더십은 "모든 것"을 문서화해야했습니다.

예를 들어, API 문서를 생성하는 데 적합합니다.

HTH는

+0

내가 '자동 문서 작성자'를 원한다는 주된 이유는 스텁을 쉽게 작성하여 채우기를 강화하는 것입니다. 우리 팀은 프런트 엔드 팀이 데이터 피드를 얻고 비즈니스 로직을 제공하는 데 사용되는 웹 서비스를 개발하므로 소스에 액세스 할 수 없으며 자동 생성 도움말이 있으므로 효율적인 문서화가 필요합니다. Sandcastle에서 생성 된 파일. 이전에 GhostDoc을 살펴 보았습니다. 나는 그것을 좋아하지 만, 프로 버전 컨텍스트 옵션을 추가하고 실제로 활성화시키지 않으면 실제로 무료 추가 기능이 정확히 무엇인지 알지 못한다. –

+1

"예를 들어 API 문서를 생성하는 데 적합합니다. ... 아주 정확히 정확히 왜이 부분을 조사하고 있습니까? 제안 주셔서 감사합니다, 나는 그것을 한 번 줄 것입니다. 망상적인 요구 사항을 가진 나쁜 프로젝트 관리자들에게도 당신의 고통을 느낍니다. 하하. –

+1

개발자가 스텁을 채우고 추가 (생성)하기 쉽도록하는 것은 대개 서로 대치되는 두 가지입니다. 나는 GhostDoc과 같은 도구가 의미있는 설명을 추가 할 수 있다고 거의 믿지 않는다. 아마 얻을 수있는 것은 문서에 어떤 가치도 추가하지 않는 쓸모없는 조항들이다. – Matze

0

나는 추가, Atomineer Pro Documentation 당신이 시도 할 수 있습니다 작성했습니다. 문서 주석을 생성하고 업데이트하여 문서를 깔끔하게 정리하고 코드와 동기화하여 문서화 작업을 최소화합니다. 무료는 아니지만 일단 사용을 시작하면 많은 시간 (돈)을 절약 할 수 있습니다.