설명서 규칙
설명서 규칙은 외부에서 볼 수 있는 API에 대해 XML 문서 주석을 올바르게 사용하여 잘 문서화된 라이브러리를 작성하도록 지원합니다.
단원 내용
규칙 | 설명 |
---|---|
CA1200: 접두사를 사용하여 cref 태그 사용 방지 | XML 문서 태그의 cref 특성은 “코드 참조”를 의미합니다. 태그의 내부 텍스트를 형식, 메서드, 속성 등의 코드 요소로 지정합니다. cref 태그는 컴파일러가 참조를 확인하는 것을 방지하므로 접두사와 함께 사용하지 마세요. 또한 접두사를 함께 사용하면 Visual Studio IDE(통합 개발 환경)에서 리팩터링 중에 기호 참조를 찾아 업데이트할 수 없습니다. |
GitHub에서 Microsoft와 공동 작업
이 콘텐츠의 원본은 GitHub에서 찾을 수 있으며, 여기서 문제와 끌어오기 요청을 만들고 검토할 수도 있습니다. 자세한 내용은 참여자 가이드를 참조하세요.
.NET