웹 서비스 (.asmx)를 통해 내 API를 노출합니다. 현재 사용 가능한 유일한 것은 기본 WSDL 도움말 페이지입니다. 이것이 대단히 도움이되는 반면, 대상 고객이 조금 더 손을 잡아야한다면 충분하지 않습니다. 예를 들어 몇 가지 예제를 포함하고 싶지만 메소드 서명 등의 자동 생성이 필요하다고 가정 해 보겠습니다.웹 서비스 API에 대한 설명서를 어떻게 작성해야합니까?
반 자동 (자동 메소드 서명이 있지만 예제를 제공 할 수 있습니까?)이 작업을 수행 할 수 있습니까? 나는 유지할 수있는 this과 같은 것을 찾고있다. 기본적으로 WSDL을 수정하는 데 도움이되는 것이 이상적입니다. 배포 할 때 문서가 서비스와 함께 자동으로 사용 가능하기 만하면됩니다.
제안 사항?
이것은 매우 쉽습니다. 모든 클래스와 메소드를 tripple /// 주석으로 꾸미면 문서를 생성 할 수 있습니다. 여기를 참조하십시오 :
http://msdn.microsoft.com/en-us/library/dd233217.aspx
http://www.developerfusion.com/article/84436/documentation-made-easy-with-c-and-xml/
어쩌면 가장 쉬운 방법은 XML 문서 주석을 사용하는 것입니다. 이러한 사용
은 자동으로 HTML 문서를 생성 할 수 있습니다 언급. Sandcastle 또는 NDoc3를 사용하여 예를 들어
Build Sandcastle Documentation When Building Visual Studio Project
그리고 당신은 자동으로 서비스 근처 공유 위치에 HTML 문서를 저장할 수 있고, 쉽게 브라우저를 사용하여이 탐색 할 수있는 모든 후
. 그래서, 모두 근처 될 수있다 - 그러나 나는 성공의 많은 NDoc3 사용했습니다다른 포스터에 동의 WSDL + HTML 문서. Sandcastle보다 훨씬 빠릅니다 (아주 좋은 도구이기도합니다). NDoc3은 .chm, .doc 및 .html 출력을 생성합니다.
NDoc3과 Sandcastle은 모두 MSDN 스타일의 문서를 생성합니다.