여전이 주석이라는 것에 대해 긍정적인 면보다는 부정적인 면이 더 많다고 생각하고 있지만.. 소스 코드와 주석을 통해 멋지게 문서를 자동으로 생성해 주는 개념은 주석에 대한 부정적인 많은 부분을 불식시키고도 남는듯합니다.

Java로 만든 어플리케이션(또는 서비스)의 소스를 협업자 또는 제3자에게 제공하기 위해 주석을 달때 JavaDoc의 도움을 받아 좀더 체계적으로 작업할 수 있도록 하기 위한 주석법입니다. 간단히 제 스스로 개발할때 참고하여 사용할만한 예제 코드로 정리해 봅니다.

먼저 클래스에 대한 주석의 예입니다.

/**  * 화면상에 윈도우를 나타내기 위한 클래스  * 사용 방법:  * <pre>  *    Window win = new Window(parent);  *    win.show();  * </pre>  *  * @author  Sami Shaio  * @version 1.0  * @see     java.awt.BaseWindow  * @see     java.awt.Button  */ class Window extends BaseWindow {    ... } 다음은 클래스의 필드에 대한 주석의 예입니다.

    /**      * 컴포넌트의 X 좌표      *      * @see #getLocation()      */     int x = 1263732; 끝으로 클래스의 매서드에 대한 주석의 예입니다.

    /**      * 지정된 index에 위치하는 문자 반환.      * index의 범위는 <code>0</code>에서 <code>length() - 1</code>까지임.      *      * @param     index  얻고자 하는 문자의 인덱스 값      * @return      지정된 index의 문자      * @exception StringIndexOutOfRangeException      *     index가 <code>0</code>에서 <code>length()-1</code>의 범위를 벗어남      * @see       java.lang.Character#charValue()      */     public char charAt(int index) {        ...     }

C++의 STL에 multimap이라는 컨테이너가 존재합니다. 이 컨테이너는 키(key)와 값(value)의 쌍으로 구성된 요소를 저장하고 있으며 key 값으로 정렬 되어 있습니다. 여기서 중요한 것은 이 키가 유일하지 않다는 점입니다. 즉 중복될 수 있다는 점인데요. 이러한 C++의 multimap의 성질을 갖는 컨터이너가 C#에는 기본적으로 존재하지 않습니다. 해서 이러한 컨터이너를 직접 개발자가 만들어 써야 하는데.. 다행히 C#에서 어렵지 않게 구현할 수 있습니다.

C#에서 제공하는 컨테이너(NET에서는 컬렉션(Collection)이라는 다른 이름을 사용) 중에 List와 SortedDictionary 컬렉션을 조합하여 우리가 원하는 C++의 multimap 컨테이너를 만들 수 있습니다. 아래는 이렇게 구현한 컬렉션으로 클래스 이름을 .NET의 이름에 맞게 MultiSortedDictionary라고 지었습니다.

class MultiSortedDictionary<Key, Value> {     private SortedDictionary<Key, List<Value>> dic_ = null;     public MultiSortedDictionary()     {         dic_ = new SortedDictionary<Key, List<Value>>();     }     public MultiSortedDictionary(IComparer<Key> comparer)     {         dic_ = new SortedDictionary<Key, List<Value>>(comparer);     }     public void Add(Key key, Value value)     {         List<Value> list = null;         if(dic_.TryGetValue(key, out list))         {             list.Add(value);         }         else         {             list = new List<Value>();             list.Add(value);             dic_.Add(key, list);         }     }     public bool ContainsKey(Key key)     {         return dic_.ContainsKey(key);     }     public List<Value> this[Key key]     {         get         {             List<Value> list = null;             if (!dic_.TryGetValue(key, out list))             {                 list = new List<Value>();                 dic_.Add(key, list);             }             return list;         }     }     public IEnumerable<Key> keys     {         get         {             return dic_.Keys;         }     } } MultiSortedDictionary 클래스의 코드가 그리 길지 않습니다. C#은 이미 매우 잘 만들어진 컬렉션 클래스를 가지고 있으므로 이들을 조합하여 쉽게 구현할 수 있었기 때문입니다. 이제 MultiSortedDictionary 클래스를 사용해 보겠습니다.

먼저 요소를 추가합니다. 요소의 키는 정수(int)이고 값(value)은 POINT라는 사용자 정의 구조체로 하겠습니다. 먼저 POINT 타입의 구조체는 아래와 같습니다.

struct POINT {     public int x;     public int y;     public POINT(int x, int y)     {         this.x = x;         this.y = y;     }     override public string ToString()     {         return String.Format("({0:D},{1:D})", x, y);     } } 이제 MuiltiSortedDictionary 클래스의 인스턴스를 생성하고 몇가지 요소를 추가하는 코드를 작성해 보면 아래와 같습니다.

static void Main(string[] args) {     MultiSortedDictionary<int, POINT> msd_         = new MultiSortedDictionary<int, POINT>();     POINT pt1 = new POINT(100, 100);     POINT pt2 = new POINT(100, 200);     POINT pt3 = new POINT(100, 300);     POINT pt4 = new POINT(100, 100);     POINT pt5 = new POINT(100, 200);     POINT pt6 = new POINT(100, 300);     msd_.Add(30, pt6);     msd_.Add(20, pt4);     msd_.Add(10, pt1);     msd_.Add(10, pt3);     msd_.Add(20, pt5);     msd_.Add(10, pt2); 실제로 키에 대해 정렬이 되어 있는지를 살펴보기 위해 임의로 요소를 추가할때 키의 순서를 정렬되지 않은 키값 순서로 추가하고 있습니다. 실제로 키 값이 정렬되어 있는지 파악하는 코드는 아래와 같습니다.

IEnumerator<int> iter = msd_.keys.GetEnumerator(); iter.Reset(); Console.Write("key list : "); while(iter.MoveNext()) {     Console.Write(iter.Current + " "); } Console.WriteLine(); 실행 결과는 아래와 같습니다.