.NET XML 문서의 참조 접두사
-
13-09-2019 - |
문제
XML 주석을 사용하여 클래스 라이브러리의 모든 유형, 방법, 속성 등을 완전히 문서화하려고했지만 cref
속성 (사용) see
예를 들어 태그). 조언에 의해 이 MSDN 페이지 MSDN 및 기타 웹 사이트에 대한 다양한 다른 예를 따르는 것 외에도 cref
태그, 그것은 refence를 분류하는 특정 마커로 접두사를 찍어야합니다 (예 : 't :'및 method의 경우 'm :').
그러나 Microsoft Sandcastle을 사용하면 이러한 접두사를 놓치면 생성 된 문서 (이 경우 CHM 도움말 파일)에 효과가 있음을 관찰했습니다. 접두사 (내가 믿는 모든 상황에서)를 포함하여, 참조는 페이지에 굵은 텍스트로 렌더링됩니다. 그러나 접두사를 공개하면 참조는 API 참조 내에 적절한 페이지에 대한 앵커 (링크)로 렌더링됩니다. 권장되는 접두사 (모두?) 참조 방법이 가장 유용한 결과를 제공한다는 것이 나에게 이상하게 보인다. 누군가가 이것에 대해 약간의 빛을 비출 수 있다면 감사하겠습니다.
제휴하지 않습니다 StackOverflow