C# 소스 코드의 주석을 인식

Question

C# 소스 코드의 주석을 인식하는 방법은 무엇입니까? 댓글에서 모든 정보를 검색하고 싶습니다. "샘플 방법"매개 변수의

설명 - - "1 인자 ..."반환 값의

설명 - 방법의

public class TestClass 
    { 
     /// <summary> 
     /// Sample method 
     /// </summary> 
     /// <param name="a">1 argument</param> 
     /// <param name="b">2 argument</param> 
     /// <param name="c">3 argument</param> 
     /// <returns>true or false</returns> 
     /// <exception cref="NotImplementedException">Always throw exception</exception> 
     public bool Method(int a, object b, Panel c) 
     { 
      throw new NotImplementedException(); 
     } 
    } 

1. 설명 "참 또는 거짓"
2. 예외 형식과 설명
3. 다른 사용자 태그

Answer 1

가장 쉬운 방법 woul

<?xml version="1.0"?> 
<doc> 
    <assembly> 
     <name>ClassLibrary2</name> 
    </assembly> 
    <members> 
     <member name="M:TestClass.Method(System.Int32,System.Object,System.Windows.Forms.Panel)"> 
      <summary> 
      Sample method 
      </summary> 
      <param name="a">1 argument</param> 
      <param name="b">2 argument</param> 
      <param name="c">3 argument</param> 
      <returns>true or false</returns> 
      <exception cref="T:System.NotImplementedException">Always throw exception</exception> 
     </member> 
    </members> 
</doc> 

Answer 2

난 당신이 데이터를 제시에 대한 계획,하지만 오픈 소스 프로젝트가 얼마나 잘 모르겠어요 ... 그리고 XML 파일을 구문 분석 - XML ​​주석 생성 (> 빌드 프로젝트 속성)를 활성화하는 거라고 nDoc이라고하며 웹 페이지에서이 정보를 멋지게 형식화합니다.

nDoc를 사용하려면 프로젝트 설정에서 xml 출력을 활성화해야합니다. 이렇게하면 모든 주석을 XML 형식으로 얻을 수 있습니다. 당신이 nDoc 그들이

Answer 3

마크의 대답은 당신의 최선의 방법이다 XML 출력을 활성화하는 방법에 대한 몇 가지 좋은 instructions를 사용하지 않는 경우에도

. 어떤 이유로 수동으로 작업하기를 원한다면 ///로 시작하는 연속 된 줄을 찾아서 연결 한 다음 해당 문자열을 XML로 처리해야합니다.

Answer 4

정말로 호를 듣고 싶다면 파서를 만들 수 있습니다. 나는 그것이 당신이 달성하고자하는 것에, 왜, 그리고 어떤 자원/시간을 넣어야하는지에 달려 있다고 생각합니다. C#을 구문 분석하려고하면 ANTLR 또는 다른 파서/컴파일러 생성기를 고려하십시오.

나는 복잡성 스펙트럼의 반대쪽으로 점프하고 있지만 상황을 알지 못하므로 적절할 수 있습니다.

주석은 완전히 파서가 없으면 까다로울 수 있습니다.

// Blah blah // another double slash on the same line. 
/* 
What about multi-line comments? 
*/ 

/* 
    // What about double-slash comments inside of multi-line comments? 
*/ 

을 (그리고 난 그냥이 가장자리의 경우에 표면을 긁는거야) : 이러한 가장자리의 경우를 생각해 보자.