[문서 자동화] 주석 메타 정보 얻기

• 소스 코드의 주석을 활용하여 자동으로 문서화 할수 있다.

    /// <summary>
    /// 책 모델
    /// </summary>
    public class Book
    {
        /// <summary>
        /// 생성 일자 
        /// </summary>
        public DateTime CreatedTime { get; set; }


        /// <summary>
        /// 책 종류
        /// </summary>
        public BookType Type { get; set; }

        /// <summary>
        /// 책 이름 
        /// </summary>
        public string Title { get; set; }

        /// <summary>
        /// 책을 생성합니다.
        /// </summary>
        /// <param name="createdTime">생성 일자</param>
        /// <param name="type">종류</param>
        /// <param name="title">이름</param>
        /// <code>
        /// var b = new Book(DateTime.Now, BookType.Game, "Diablo II");
        /// </code>
        public Book(DateTime createdTime, BookType type, string title)
        {
            CreatedTime = createdTime;
            Type = type;
            Title = title;
        }

        /// <summary>
        /// 책 정보 출력
        /// </summary>
        /// <returns>책 정보를 출력</returns>
        public override string ToString()
        {
            return $"{CreatedTime} {Type}";
        }
    }

 

• Visual Studio -> 프로젝트 속성 -> 출력 -> 설명서 파일 -> XML 설명서 파일 경로 기입
• 빌드 조건(Debug or Release) 만족시, 해당 경로에 주석 메타 정보가 담긴 XML 파일이 생성된다.

 

API 설명서 XML 생성 설정 위치

 

• 생성된 파일을 열어 보면 MSDN의 생성 규칙에 따라 주석 정보를 담은 XML 파일을 확인 할 수 있다.

Book 생성자 코드 주석 샘플

 

 

• 태그의 이름은 <명명규칙><네임스페이스> 순으로 따른다.
• MSDN - 주석 설명

XML 문서 주석 - /// 주석을 사용하여 API 문서화

 

• 생성된 XML을 활용하여 Word, HTML 정적페이지든 원하는 방향으로 이용하면 될 것 같다.
• Jenkins 활용하여 Master 배포 시 정적페이지 자동 생성을 할 수 있다.