728x90

클래스 참조하여 사용을 할때 클래스에 대한 설명이 다음과 같이 나온다.

 

위와 같이 필요한 설명은

클래스의 메서드 부분에 주석 처리를 하면 된다.

 

summary 주석 처리는 슬래시(/) 키를 세번 누르면 자동으로 생긴다.

 

/// <summary>
///
/// </summary>
/// <param name="e"></param>

 

■ 예제

 Class1.cs

     /// <summary>
    /// 주어진 스트링을 주어진 길이만큼만 잘라서 돌려줌.
    /// </summary>
    /// <param name="strCut">잘라낼 원본 문자열</param>
    /// <param name="intChar">제한할 글자 수</param>
    /// <returns>제한된 문자열</returns>
    public static string CutString(string strCut, int intChar)
    {
        if (strCut.Length > intChar - 3)
        {
            string strTemp = "";
            strTemp = strCut.Substring(0, intChar - 3);
            strTemp += "...";

            return strTemp;
        }
        else
        {
            return strCut;
        }
    }

 

 

■ 메서드 요약설명

      /// <summary>
    /// 주어진 스트링을 주어진 길이만큼만 잘라서 돌려줌.
    /// </summary>
 

 

■ 첫번째 인자값 설명

 /// <param name="strCut">잘라낼 원본 문자열</param>
 

 

■ 두번째 인자값 설명

 /// <param name="intChar">제한할 글자 수</param>
 

 

[ XML 주석 레퍼런스]

<summary>

데이터 형식이나 멤버에 대한 짤막한 요약을 제공한다.

<param>

메소드 인수를 표시한다.

<returns>

메소드의 반환값을 설명한다.

<example>

설명하고 있는 항목에 대한 코드 예제를 나타냄

<code>

여러줄을 코드로 표시하는데 사용

<remarks>

클래스나 다른 형식에 대한 개요를 지정할 있는 태그입니다

<exception>

함수내에서 발생할 있는 에러정보를 나타냄


출처 : http://blog.naver.com/whwlfnsl/70025332256
728x90
3. XML의 구성요소

  벌써 세 번째 강좌네요. 강좌라고 하기에는 초라하기 그지없지만...~~

기초강좌를 마치고 나서는 MSSQL에서의 XML을 사용하는 방법을 할까 하네요. 예전에도 있었던 거죠.. 그리고 나서, 최근에 나온 Oracle의 XML DB에 대해서도 해볼까 하네요.. 아무래도 미니는 DB쪽에 좀더 호기심이 있네요.. ^^



오늘은 지난번에 간단하게 살펴본 XML 문서내에서 사용되는 구성요소들을 하나하나 설명하려고 합니다.

이것은 XML 스펙에 보면 잘 나와 있습니다. 한글로 된 XML 스펙이 많이 돌아다니고 있으니까요..한번씩 살펴 보세요.

  <?xml version="1.0"?>

<html>

   <head>

      XML Developer

   </head>

   <body>

     <img src="xml.gif"/>

     <a href="http://www.word.pe.kr">Hello World</a>

   </body>

</html>



위와 같은 문서도 분명히 XML 문서입니다. 위의 예제를 가지고 XML의 구성요소를 살펴보도록 하죠.





엘리먼트 (Element)



어떤 책에는 요소라고 번역되어 있기도 하더군요. 엘리먼트와 루트 엘리먼트에 대해서는 지난 강좌에서 설명을 하였죠.

복습차원에서 다시 한번 알아보면 위 문장에서 루트 엘리먼트는 <html>이 되겠죠.

루트 엘리먼트는 다른 엘리먼트를 모두 포함하고 있는 것을 말하죠.



그밖에 <head>, <body>, <a>와 같은 태그를 시작 태그라 하구요.</head>, </body>, </a> 같은 태그를 닫는 태그라 하죠

그리고 이러한 <head>..</head>, <body>...</body>, <a>...</a>를 엘리먼트라고 하죠.

그런데 HTML에서는 닫는태그를 빼먹어도 별 문제가 안됐어요.. 하지만  XML에서는 이러한 태그가 빠진다면 에러로 인식하게 됩니다.

반드시 모든 엘리먼트는 쌍으로 이루어져야 한다는 것이지요.



그렇다면 <br>, <img>와 같이 혼자서 존재할 수 있는 엘리먼트는 어떻게 해야 할까요?

XML 스펙에 따르면 위와 같은 것들은 엘리먼트 내에 내용을 포함하지 않은 것으로서 빈 엘리먼트 (Empty Element)라고 합니다.

이러한 빈 엘리먼트의 표기법은 <br></br>

<br/>



와 같은 두가지 형태로 표현 가능합니다. 일반적으로는 두 번째 방식으로 표현을 많이 하더군요.

위의 예제에서도 <img src="xml.gif"/>와 같은 표현을 볼 수 있을 것입니다.



마지막으로 엘리먼트에서 고려해야 할 사항은 시작태그와 끝태그의 엘리먼트 이름이 같아야 한다는 것입니다.

만약 다음과 같이 엘리먼트가 사용되었다면 잘못된 것입니다. <head>XML Developer</tail>







속성 (Attribute)



위의 예에서 <img>태그를 살펴보면, <img>태그는 그림을 나타내고 그림의 소스는 xml.gif라는 것을 우리는 알 수 있습니다.

만약 <img/>와 같이 혼자만 사용되었다면 아무런 의미를 가질 수 없게 될 것입니다.

HTML에서 처럼 이와 같은 것을 속성이라고 부릅니다. 엘리먼트는 속성을 포함할 수 가 있는 거지요.



속성은 문서를 간결하고 해석하기 쉽도록 만들어줍니다.

만약 속성이 없었다면 <img>태그를 다음과 같이 표현할 수도 있을 것입니다. <img>

    <src>xml.gif</src>

    <align>center</align>

</img>





그러나 속성을 활용하면 <img src="xml.gif" align="center"/>



과 같은 형태로 나타낼 수 있습니다.



첫 번째 형태도 잘못된 것은 아닙니다.  그러나 두 번째의 경우가 보다 간결하고 해석하기도 용이한 형태로 이루어져 있지요..

실제로 DTD를 설계할 기회가 생긴다면 저렇게 자식 엘리먼트로 넣을 것인가? 아니면 속성으로 처리할 것인가를 가지고 많은 고민을 하게 됩니다.

MS-SQL의 경우 XML로 DB에서 데이터를 가져올 때 이 속성을 활용하고 있습니다.



속성에서 주의해야 할 것이 하나 있습니다. HTML에서는 다음과 같은 표기법도 허용되었습니다.

<img src=xml.gif>

그러나 XML에서 속성값은 반드시 " 나 '로 둘러쌓여 있어야 합니다. 만약 그렇지 않다면 Well-formed한 문서가 되지 못하죠.

즉, 이러한 형태로 사용되어야 한다는 것입니다. <img src="xml.gif">



<img src='xml.gif'>







처리명령 (Processing Instruction)



<? 와 ?>사이에 표현되고 특정 응용 프로그램에 대해 처리할 정보나 명령을 가리키는 역할을 합니다.

대표적으로 XSL을 선언하는 부분을 예로 들수 있습니다. <?xml:stylesheet type="text/xsl" href="메모.xsl"?>



위와 같이 적용되면 XML의 스타일쉬트를 지정하고 타입은 text/xsl이며 소스는 메모.xsl에 있다

라고 해석할 수 있는 것이지요. 이렇게 해석할 수 있도록 제공하는 것을 처리명령이라고 합니다.



<?xml version="1.0"?>

와 같은 것도 처리명령이라고 할 수 있습니다. 형태가 처리명령과 같지요. 여기서는 XML 버전 1.0을 사용한다라고 가리키고 있습니다.

그런데 XML에서는 이와 같은 것을 특별히 XML 선언이라고 부릅니다. 모든 XML 문서의 시작은 XML 선언으로 해야 하지요.



위 예제에서는 사용되지 않았지만 몇가지 중요한 XML의 구성요소를 추가로 설명하도록 하겠습니다.





엔터티 (Enitity)



< > & 와 같은 것들을 HTML에서 여러번 보았을 것입니다. 이것은 각각 < > &를 나타내지요.

이러한 것을 엔터티라고 합니다. 엔터티의 가장 일반적은 형태는 문자열을 특정 문자열로 대체하는 것이라고 할 수 있습니다.

예를 들어 만약 DTD문서에 다음과 같이 선언되어 있다면



<!ENTITY xml "eXtensible Markup Language">



이것을 XML 문서 내에서 사용할 때는 &xml;과 같이 사용합니다.

그럼 XML 프로세서는 &xml; 이 부분을 eXtensible Markup Lanaguage로 변환하여 사용하게 됩니다.



또한 엔터티는 이미지와 같은 Binary 데이터나 비 ASCII 문자를 대체하기 위해서도 사용된다고 합니다.

그리고 이러한 엔터티를 DTD에서도 사용할 수 있는데요. 그러한 것을 특별히 파라미터 엔터티라고 하기도 합니다.



대략적으로 엔터티에 대한 설명을 했는데요.. 솔직히 XML 구성요소에서 가장 설명하기가 난해한 것이라고 생각됩니다.

범위도 넘 넓구요.. 엔터티는 잘 사용하면 무지 편한데.. 개념이 도통 어려워서.. 제가 공력이 쌓이면 엔터티에 대한 글을 좀더 상세히 쓰도록 하죠..





주석 (Comment)



주석은 <!-- 와 --> 사이에 정의되고요. HTML에서와 같은 형태와 의미를 가지고 있습니다.

즉, 문서 자체에서 의미를 가지지 않고요. XML 프로세서가 문서를 해석할 때도 건너 뛰게 되지요.

그러므로 실제 XML 문서에 대한 설명을 위해서 주로 사용하게 되지요. <!-- 이부분은 <head>와 <body>를 위한 주석입니다. -->







CDATA 섹션 (CDATA Section)



모든 문자를 마크업이나 태그로 인식하지 않고 일반 문자로 인식하도록 할 수 있는 표기법입니다.

만약 <greeting>Hello World</greeting>



과 같은 형태로 사용하면 이것은 하나의 <greeting>이라는 엘리먼트가 되구요.. 그 엘리먼트의 내용이 Hello World가 되죠.

하지만 만약 전체를 문자열로서 사용하고 싶다면??

앞에서 엔터티란 것이 있었죠.. 엔터티를 활용해서 표현할 수도 있습니다.  그러나 모두 엔터티로 처리하게에는 좀 부담스럽죠.

그래서 등장한 것이 바로 CDATA섹션입니다.

  <![CDATA[

   <greeting>Hello World</greeting>

]]>



이렇게 사용하면 <greeting>Hello World</greeting>를 모두 문자열로 인식하게 됩니다.

XSL과 같은 문서에서 자바스크립트를 많이 사용하거든요.. 그때 이 CDATA 섹션을 많이 사용하게 됩니다.



여기까지 XML의 구성요소를 설명하였습니다. 함 정리 해 볼까요?

구성요소                                         설명

엘리먼트(Element)                        마크업 태그와 그안에 포함된 내용

빈 엘리먼트 (Empty Element)       데이터와 같은 내용을 포함하지 않은 엘리먼트

루트 엘리먼트 (Root Element)      문서내 모든 엘리먼트와 내용을 포함하고 있는 XML 문서의 엘리먼트

속성 (Attribute)                 엘리먼트에 포함되어 추가적인 정보를 제공

엔터티 (Entity)                  텍스트, Binary 데이터, 비 ASCII 문자를 저장하는데 사용

처리명령 (Processing Instruction) 전체 문서나 문서의 일부를 처리하는 응용 프로그램과 연결해 주는 명령어

주석 (Comment)                   XML 프로세서가 해석하지 않는 설명문

CDATA 섹션 (CDATA Section)       특수한 문자를 일반 텍스트로 인식하도록 하는 표기법



오늘은 여기까지입니다. 강좌를 올린다는게 참 어려운 작업인것 같네요.. ^^ 하지만 제 자료를 잘 정리해 놓는다는 기분으로 하면 될 것 같네요.. 그럼 2002/08/02  From 미니

출처 : 미니의 XML DeveloperGroup (http://www.word.pe.kr)

'프로그램언어 > XML' 카테고리의 다른 글

6. XSL & XML  (0) 2008.06.02
5. DTD & XML  (0) 2008.05.28
4. DTD란?  (0) 2008.05.14
2. XML의 시작  (0) 2008.05.14
1.1 XML 이란?  (0) 2008.05.14

+ Recent posts