비주얼 스튜디오에서 누락 된 XML 댓글 콘텐츠 찾기

StackOverflow https://stackoverflow.com/questions/264623

  •  06-07-2019
  •  | 
  •  

문제

전체 또는 C# sourcecode 우리는 다음과 같은 실제 컨텐츠를 놓치는 많은 주석이 있습니다.

/// <summary>
/// </summary>

아니면 이거:

/// <summary>
///
/// </summary>

아니면 이거:

/// <param Name="flag"></param>

불행히도 Visual Studio는 이러한 유형의 누락 된 의견에 대한 경고를 생성하지 않습니다. 그러나 우리에게는 Visual Studio 내부의 목록 (예 : Warings List)의 항목을 Klick 할 수 있고 소스 코드의 결함이있는 위치로 가져 가면이를 수정할 수 있습니다. 또한 XML 파일의 각 빌드에서 누락 된 XML 주석 내용 목록을 보는 것이 좋을 것입니다. 이것을 달성하는 방법에 대한 아이디어가 있습니까?

도움이 되었습니까?

해결책 2

Resharper는 Visual Studio의 (다른 많은 다른) 단점에 대한 답입니다. 나는 그것을 사용하지 않는 사람에게는 불쌍한 것이 없습니다. ;)

다른 팁

노력하다 XML 댓글 검사기:

XML Comment Checker는 생략에 대한 .NET 어셈블리의 XML 문서를 확인하는 응용 프로그램입니다. 그것은 C# 컴파일러 자체보다 더 포괄적 인 점검을 제공하며 예를 들어 Microsoft Sandcastle을 사용하여 실제 문서로 컴파일하기 전에 의견을 확인하려는 경우에 이상적입니다.

기능 목록에서 :

빈 섹션을 확인하십시오. 선택적으로, XML 주석 검사기는 필요한 섹션이나 요소가 존재하지만 비어있는 경우 경고합니다. 기본적으로 활성화되지 않습니다

Visual Studio의 사용 :

XML 주석 검사기는 비주얼 스튜디오에서 구축 후 이벤트로 설정하여 조립품을 자동으로 확인할 수 있습니다. XML Comment Checker가 배출 한 경고는 비주얼 스튜디오가 그들을 인식하도록 형식화되었습니다. 오류 목록에 표시하십시오. 예제 사후 구축 명령 줄 : "PathTocommentChecker CommentChecker.exe" "$ (TargetPath)"-nologo -warnemptysections

fxcop 그리고 맞춤 규칙?

XSLT 파일을 사용하고 XSLT 파일에 대해 XML을 디버깅 할 수 있으며 XML이 잘 형성되지 않은 경우 XML이 잘 형성되지 않은 정확한 줄 번호를 보여 주면 오류가 발생합니다. 이 간단한 XSLT 파일이 작동합니다.

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
    xmlns:msxsl="urn:schemas-microsoft-com:xslt" exclude-result-prefixes="msxsl"
>
    <xsl:output method="xml" indent="yes"/>

    <xsl:template match="@* | node()">
        <xsl:copy>
            <xsl:apply-templates select="@* | node()"/>
        </xsl:copy>
    </xsl:template>
</xsl:stylesheet>
라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top